AccuZIP DQ CASS RESTful API

Use this web service call to confirm the US, US Territory and Canadian Mailing Addresses

Base URI

https://api.cassonline.com
API Methods
POST /servoy-service/rest_ws/ws_address/ws_validate
Validate Addresses
POST /servoy-service/rest_ws/ws_address/ws_validate

CASS Certify One Address

Request body

Object
API_KEY
string

AccuZIP will provide an API_KEY specific to your organization

Example:
{{api_key}}
AZSetQuery_iadl2
string

Company Name

Example:
ACME INC.
AZSetQuery_iadl1
string

Mailing Address Line 1

Example:
1333 WEST GARVEY AVE NORTH APARTMENT 120
AZSetQuery_iadl3
string
Example:
Secondary Information (Ste/Apt) IF not provided in AZSetQuery_iadl1
AZSetQuery_ictyi
string
Example:
City Name
AZSetQuery_istai
string

State Abbreviation

AZSetQuery_izipc
string

Postal Code

AZSetQuery_icountry
string

Optional for US Addresses. For Canadian Addresses use: CA (Optional)

Example:
US
AZSetQuery_iforeignid
string

Unique Record ID (Optional)

Example:
534d93d8-1cbe-437d-81db-ff1abee29aa4
mixedcase
string

Returns the Standardized Address as Mixed Case if set to 1, otherwise UPPER CASE.

Example:
1
Examples

Example of CASS Certifying One Address

{
	"API_KEY": "{{api_key}}",
	"Address": [{
		"AZSetQuery_iadl2": "AccuZIP Inc.",
		"AZSetQuery_iadl1": "2450 S Shore Blvd, Ste 125",
		"AZSetQuery_iadl3": "",
		"AZSetQuery_ictyi": "League City",
		"AZSetQuery_istai": "TX",
		"AZSetQuery_izipc": "",
		"AZSetQuery_icountry": "US",
		"AZSetQuery_iforeignid": "534d93d8-1cbe-437d-81db-ff1abee29aa4"
	}]
}

Example of CASS Certifying Multiple Addresses (Max of 20 is recommended)

{
	"API_KEY": "{{api_key}}",
	"Address": [{
		"AZSetQuery_iadl2": "AccuZIP Inc.",
		"AZSetQuery_iadl1": "2450 S Shore Blvd, Ste 125",
		"AZSetQuery_iadl3": "",
		"AZSetQuery_ictyi": "League City",
		"AZSetQuery_istai": "TX",
		"AZSetQuery_izipc": "",
		"AZSetQuery_icountry": "US",
		"AZSetQuery_iforeignid": "534d93d8-1cbe-437d-81db-ff1abee29aa4"
	},
	{
		"AZSetQuery_iadl2": "ACCUZIP",
		"AZSetQuery_iadl1": "3216 El Camino Real",
		"AZSetQuery_iadl3": "",
		"AZSetQuery_ictyi": "",
		"AZSetQuery_istai": "",
		"AZSetQuery_izipc": "93422",
		"AZSetQuery_icountry": "US",
		"AZSetQuery_iforeignid": "6d4a6b0f-3ce5-4d07-abe0-5099f1626e7c"
	}]
}

Responses

200 OK

JSON format

200 Example Response of CASS Certifying Multiple Addresses

Examples

POST https://api.iaccutrace.com/servoy-service/rest_ws/ws_address/ws_validate HTTP/1.1 

Content-Type: application/json

{
    "API_KEY": "{{api_key}}",
    "Address": {
        "AZSetQuery_iadl1": "3216 EL CAMINO REAL",
        "AZSetQuery_ictyi": "ATASCADERO",
        "AZSetQuery_istai": "ca",
        "AZSetQuery_izipc": "93422"
    }
}

HTTP/1.1 200 OK 
CASS RESTful API JSON Object Value Descriptions:

JSON Object = DESCRIPTION

0 = Reserved For Future Use

1 = Reserved For Future Use

2 = Reserved For Future Use

3 = Reserved For Future Use

4 = Reserved For Future Use

5 = Unofficial Po Name

A = Zip Corrected

ABCTY = Standardized City Abbreviation

ADDON = ZIP+4 Addon Code

ADDON_HIGH = ADD On High

ADDON_LOW = ADD On Low

B = City/State Corrected

C = Invalid City/State/Zip

CONGRESS_DIST = Congressional District

COUNTY_NO = Fips County Code

COUNTY_NO = County Number

CRIS = Carrier Route

D = No Zip Assigned

DADL1 = Standardized Delivery Address

DADL2 = Standardized Firm Name

DADL3 = Standardized 2ND Delivery Addr

DCTYA = Standardized City

DCTYS = Main Post Office City

DLAST = Standardized City/State/Zip

DLAST = Last Line City/State Key

DPBC = Delivery Point Bar Code

DPVA = DPV Confirmation Indicator Note: The DPV Confirmation Indicator is the primary method used by the USPS to determine whether an address was considered deliverable or undeliverable.

Y = Address was DPV confirmed for both primary and (if present) secondary numbers.

D = Address was DPV confirmed for the primary number only, and Secondary number information was missing.

S = Address was DPV confirmed for the primary number only, and Secondary number information was present but unconfirmed.

N = Both Primary and (if present) Secondary number information failed to DPV Confirm.

Blank = Address not presented to hash table.

DPVC DPV CMRA Indicator Note: CMRA Indicates a private business that acts as a mail-receiving agent for specific clients. Y = Address was found in CMRA table.

N = Address was not found in CMRA table.

Blank = Address not presented to hash table.

DPVF DPV False Positive Indicator

Note: This is a flag to determine whether a mailing list is being generated or created during validation. Creating a mailing list through DPV certification is not allowed by the USPS. Y = Address was found in False Positive table.

N = Address was not found in False Positive table.

Blank = Address not presented to hash table.

DPVFOOT_A1 ZIP4 did not match - 1=MATCH; 0=NO Match

DPVFOOT_AA ZIP4 matched - 1=MATCH; 0=NO Match

DPVFOOT_BB Confirmed entire address - 1=MATCH; 0=NO Match

DPVFOOT_CC** Confirmed address by dropping secondary info - 1=MATCH; 0=NO Match

DPVFOOT_F1 Military Match - 1=MATCH; 0=NO Match

DPVFOOT_G1 General Delivery Match - 1=MATCH; 0=NO Match

DPVFOOT_M1 Primary number missing from address - 1=MATCH; 0=NO Match

DPVFOOT_M3 Could not confirm address - 1=MATCH; 0=NO Match

DPVFOOT_N1 Confirmed a highrise or box type address w/o secondary info - 1=MATCH; 0=NO Match

DPVFOOT_P1 Box type address missing box number - 1=MATCH; 0=NO Match

DPVFOOT_P3 Box number invalid - 1=MATCH; 0=NO Match

DPVFOOT_R1 Confirmed a highrise or box type address w/o secondary info - 1=MATCH; 0=NO Match

DPVFOOT_RR Confirmed address - 1=MATCH; 0=NO Match

DPVFOOT_U1 Unique ZIP Code record - 1=MATCH; 0=NO Match

DPVV Vacant Indicator Note: A delivery point was active in the past, but is currently vacant (in most cases, unoccupied over 90 days) and not receiving delivery.

Y = Address was found in VACANT table.

N = Address was not found in VACANT table.

Blank = Address not presented to hash table.

DPVX DSF2 No Stats Indicator (New) Note: Indicates the address is not receiving delivery, and the address is not counted as a possible delivery. These addresses are not receiving delivery because A) delivery has not been established; B) customer receives mail as a part of a drop; or C) the address is no longer a possible delivery because the carrier destroys or returns all of the mail.

Y = Address was found in NOSTATS table.

N = Address was not found in NOSTATS table.

Blank = Address not presented to hash table.

DSTAA Main Post Office State

DSTAA Standardized State

E Zip Assigned For Mult Response

ELOT_CODE Elot Ascending/Descending Flag

ELOT_NUM Elot Number

F No Zip Available

FINANCE Finance Code

FOOTNOTES Footnote String

G Part Of Firm Moved To Address

H Secondary Number Missing

I Insufficient/Incorrect Data

IADL1 Input Delivery Address

IADL2 Input Firm Name

IADL3 Input Second Address Line

ICTYI Input City

IPRURB Input Urbanization Name

IRECID Input Record ID

ISTAI Input State

IZIPC Input ZIP+4 Code

J Dual Input

K Multi Caused By Cardinal Rule

L Del Addr Component Add/Del/Chg

LLKRC Lacs Link Return Code

LACS Lacs Converted Status

LLKIND Lacs Link Indicator

M Street Name Spelling Changed

MISC Reserved For Future Use

MPNUM Matched Primary Number

MSNUM Matched Secondary Number

MUNICIPALITY Municip. City/State Key (not Filled)

N Delivery Addr Was Standardized

O Low +4 Tie-Breaker (multi-Response)

P Better Delivery Address Exists

PMB PMB Unit Designator

PMBNUM PMB Number

POST_DIR Post-Direction Abbrev

PPNAM Primary Name

PPNUM Primary Number

PPRE1 First or Left Pre-Direction

PPRE2 Second or Right Pre-Direction

PPST1 First or Left Post-Direction

PPST2 Second or Right Post-Direction

PRE_DIR Pre-Direction Abbrev

PROTE Rural Route Number

PSNUM Secondary Number

PSNUM2 Matched Secondary Number

PSUF1 First or Left Suffix

PSUF2 Second or Right Suffix

PUNIT Secondary Number Unit

PUNIT2 Secondary Number Unit

Q Unique Zipcode

R No Match Due To Ews

REC_TYPE Record Type

RESPN Number Of Returned Responses

RETCC Return Code

S Invalid Secondary Number

SEC_CODE Secondary Even Odd Code

SEC_HIGH Secondary High Range

SEC_LOW Secondary Low Range

SEC_NAME BLDG or Firm Name

STATE State Abbreviation (not Filled)

STELNKIND Stelnk Footnote

STR_NAME Street Name

SUFFIX Suffix Abbrev

T Multiple Caused By Magnet Rule

U Unofficial Po Name

UNIT Secondary Abbreviation

V Unverifiable City/State

W Small Town Default

X Unique Zip Code Generated

Y Military Match

Z Zip Move Match

ZIPC 5-DIGIT Zip Code