Part 2: CDYNE Postal Address Verification API Operations Overview

CDYNE Postal Address Verification API offers nine programming operations that deliver address data verification and data returns in a variety of ways. Each operation specializes in a specific set of data returns so businesses can select only the address information they need from a wider range of options. The following is a summary of each operation with an example of how each one can be used.

VerifyAddress Operation

This programming operation is the barebones Web Service call for users who only need to validate whether or not an address is deliverable.  Address deliverability status is returned through the DPV Return Code system, which indicates the parts of the address that are incorrect, and will return corrected information on file with the USPS. In the example below, the left column shows the address sent to CDYNE Postal Address Verification (along with the required license key). The right column shows the corrected address. It has been standardized in all caps, the suite designator has been corrected to “STE,” and the zip+4 number “2518” has been appended to the five-digit zip code. Most importantly, CDYNE Postal Address Verification returns the code 100. This means all parts of the address are confirmed as deliverable (see DPV Return Codes below the example).  DPV is a USPS validation process that confirms the existence of a specific address (down to the apartment or suite number) and whether or not it is a valid destination for a mailing or package.

Additionally, CDYNE Postal Address Verification will return the county, country, and return code data. The return code designates the status of the Delivery Point Validation (DPV) information on file with the USPS.

CDYNE Postal Address Verification DPV Return Codes:

  • 10 – Input address is not found
  • 100 – Input address is DPV confirmed for all components
  • 101 – Input address is found, but not DPV confirmed
  • 102 – Input address primary number is DPV confirmed – Secondary number is present but not DPV confirmed
  • 103 – Input address primary number is DPV confirmed – Secondary number is missing
  • 200 – Canadian address on input. Verified on city level only

To see examples of addresses with return codes, see Part 3: CDYNE Postal Address Verification VerifyAddress Operation.

VerifyAddressAdvanced Operation

In addition to validating whether an address is deliverable, this programming operation returns a host of optional information at no extra charge including geolocation, legislative, census, and mailing industry information. These options can be turned on with a true value within the web service call (the default value is set to false). In the example below, census, geo location, legislative, mailing industry, and residential delivery indicators were set to true. The advantage of the VerifyAddressAdvanced Operation is the ability to customize the data return according to your business needs.

The example above does not show all of the data available for return. Please see Part 4: CDYNE Postal Address Verification VerifyAddressAdvanced Operation which details the complete features and capabilities of this programming method.

GetIntelligentMailBarcode

CDYNE Postal Address Verification API can be used to obtain an Intelligent Mail Barcode string to generate a barcode for mail discounts. The first step is to run an address through the VerifyAddressAdvanced operation, which will return the Intelligent Mail Barcode Key as shown in the example below.

Once the Intelligent Mail Barcode Key is obtained, the second step is to run the GetIntelligentMailBarcode operation. There are six required input values, and they are defined as the following:

  • Barcode Identifier — a two-digit number assigned by the USPS to encode the presort identification
  • Service Type Identifier — a three-digit number assigned by the USPS for any combination of services requested on the mailpiece
  • Mailer Identifier — a unique six or nine-digit number assigned by the USPS that identifies a business entity
  • Serial Number — a six or nine-digit number assigned by the mailer for uniquely identifying and tracking mailpieces
  • Intelligent Mail Barcode Key — the data string returned by CDYNE Postal Address Verification VerifyAddressAdvanced operation
  • License Key — a unique data string assigned by CDYNE Corporation to run Postal Address Verification transactions

The string data in the Intelligent Mail Barcode return can be used to generate barcodes for postal mailing discounts.

CDYNE Postal Address Verification GetIntelligentMailBarcode Return Codes:

  • 0 – Success
  • 1 – Invalid input

 

GetZipCodesWithinDistance

This operation returns all zip codes within the radius of a designated latitude and longitude. In the example below, the latitude/longitude and a radius of 1 mile returns five zip codes for that geolocation. The GetZipCodesWithinDistance operation also includes a return code of “0” which means “success.” The return codes for the GetZipCodesWithinDistance operation are listed below.

CDYNE Postal Address Verification GetZipCodesWithinDistance Return Codes:

  • 0 – Success
  • 1 – Invalid input
  • 2 – Invalid license key
  • 3 – Returned zero zip codes
  • 4 – Outside of the latitude and longitude range

 

GetZipCodesForCityAndState

The GetZipCodesForCityAndState programming operation returns all zip codes associated with the city name and state provided at input. The example below returns nine zip codes for Chesapeake, VA, with a return code of “0” or successful. The return codes for the GetZipCodesForCityAndState operation are listed below.

CDYNE Postal Address Verification GetZipCodesForCityAndState Return Codes:

  • 0 – Success
  • 1 – Invalid input
  • 2 – Invalid license key
  • 3 – No match

 

GetZipCodesForFips

Federal Information Processing Standard or FIPS are standards developed by the U.S. government for use in computer systems by all non-military government agencies and government contractors. The U.S. Census Bureau uses FIPS codes to identify legal and statistical entities including states and counties. By inputting the FIPS code value, you can obtain the associated zip codes as shown in the example below.

If you do not have the FIPS value, one way to obtain is through the VerifyAddressAdvanced method. Here is an example:

CDYNE Postal Address Verification GetZipCodesForFips Return Codes:

  • 0 – Success
  • 1 – Invalid input
  • 2 – Invalid license key
  • 3 – Returned zero zip codes

 

GetCongressionalDistrictByZip

This operation returns the congressional district associated with the zip code provided at input.

CDYNE Postal Address Verification GetCongressionalDistrictByZip Return Codes:

  • 0 – Success
  • 1 – Invalid input
  • 2 – Invalid license key
  • 3 – No match
  • 4 – Multiple match

 

GetCityNamesForZipCode

Cities in a zip code may be referred to by more than one name or spelling. The GetCityNamesForZipCode operation returns the actual city name as well as acceptable alternatives. In the example below, the default city name is “Boynton Beach” and an alternate name is “Village of Golf.” Both city names are acceptable city names on file with the USPS.

CDYNE Postal Address Verification GetCityNamesForZipCode Return Codes:

  • 0 – Success
  • 1 – Invalid input
  • 2 – Invalid license key
  • 3 – No match

 

GetUrbanizationListForZipCode

Urbanizations are commonly used in Puerto Rico urban areas and they denote an area, sector, or residential development within a geographic area. They are important designators because identical street names and address number ranges can be found within the same zip code. In the following example, the urbanization name is the only element that identifies the location of a particular address.

MR OSIRIS GONZÁLEZ
URB ROYAL OAKS
123 CALLE 1
BAYAMÓN PR 00961-0123

MR PEDRO RIVERA
URB HERMOSILLO
123 CALLE 1
BAYAMÓN PR 00961-1212

CDYNE’s GetUrbanizationListForZipCode programming method will return the urbanization list for the zip code input. In the following example, the zip code, “00965” returns five urbanization names. Urbanizations typically use the abbreviation URB, but there are exceptions as shown in the example below. BDA (Barriada), BO (Barrio), and VILLA (Villa) are the correct abbreviations to use. The USPS published a detailed addressing standards document for Puerto Rico and US Virgin Islands, which can be found here.

CDYNE Postal Address Verification GetUrbanizationListForZipCode Return Codes:

  • 0 – Success
  • 1 – Invalid input
  • 2 – Invalid license key
  • 3 – No match

 

You can read the rest of the blog series by accessing the links below:

Part 1: CDYNE Postal Address Verification API Overview

Part 3: CDYNE Postal Address Verification VerifyAddress Operation

Part 4: CDYNE Postal Address Verification VerifyAddressAdvanced Operation

Part 5: CDYNE Postal Address Verification DPV Code Suggestions

For more information about CDYNE Postal Address Verification, please contact an account representative at 1-800-984-3710, inquire by email, or initiate a chat for more details.

Or sign up for a free trial license key to test CDYNE Postal Address Verification.

Leave a reply