AccuZIP CASS RESTful API

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

Base URI

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

CASS Certify a single 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

Secondary Information (Ste/Apt) IF not provided in AZSetQuery_iadl1

AZSetQuery_ictyi
string

City Name

Example:
WEST COVINA
AZSetQuery_istai
string

State Abbreviation

Example:
CA
AZSetQuery_izipc
string

USA ZIP Code

Example:
91790
AZSetQuery_icountry
string

Optional for US Addresses (Optional)

Example:
US
AZSetQuery_iforeignid
string

Unique Record ID (Optional)

Example:
534d93d8-1cbe-437d-81db-ff1abee29aa4
Examples
{
    "API_KEY": "{{api_key}}",
    "AZSetQuery_iadl2": "ACME INC.",
    "AZSetQuery_iadl1": "1333 WEST GARVEY AVE NORTH APARTMENT 120",
    "AZSetQuery_iadl3": "",
    "AZSetQuery_ictyi": "WEST COVINA",
    "AZSetQuery_istai": "CA",
    "AZSetQuery_izipc": "91790",
    "AZSetQuery_icountry": "US",
    "AZSetQuery_iforeignid": "534d93d8-1cbe-437d-81db-ff1abee29aa4"
}

Responses

200 "success": true

{

"Addr_Result": [{

	"dpbc": "453",
	
	"DPVfoot_R1": "0",
	
	"zipc": "91790",
	
	"DPVfoot_BB": "1",
	
	"ppnam": "GARVEY",
	
	"istai": "CA",
	
	"foreignid": "534d93d8-1cbe-437d-81db-ff1abee29aa4",
	
	"post_dir": "N",
	
	"dlast": "WEST COVINA CA 91790-2280",
	
	"county_no": "037",
	
	"DPVfoot_RR": "0",
	
	"DPVfoot_AA": "1",
	
	"elot_num": "0020",
	
	"DPVV": "N",
	
	"DPVX": "N",
	
	"ppre2": "",
	
	"retcc": "31",
	
	"ppre1": "W",
	
	"pre_dir": "W",
	
	"D": "",
	
	"E": "E",
	
	"F": "",
	
	"G": "",
	
	"msnum": "120",
	
	"A": "",
	
	"B": "",
	
	"C": "",
	
	"L": "",
	
	"M": "",
	
	"N": "N",
	
	"O": "",
	
	"H": "",
	
	"I": "",
	
	"J": "",
	
	"K": "",
	
	"LlkRc": "",
	
	"DPVA": "Y",
	
	"U": "",
	
	"T": "",
	
	"W": "",
	
	"V": "",
	
	"Q": "",
	
	"P": "",
	
	"S": "",
	
	"R": "",
	
	"pmb": "",
	
	"DPVF": "",
	
	"iadl1": "1333 WEST GARVEY AVE NORTH APARTMENT 120",
	
	"Y": "",
	
	"X": "",
	
	"iadl3": "",
	
	"DPVC": "N",
	
	"iadl2": "ACME INC.",
	
	"Z": "",
	
	"DPVfoot_U1": "0",
	
	"elot_code": "A",
	
	"stelnkInd": "",
	
	"DPVfoot_CC": "0",
	
	"04": "",
	
	"05": "",
	
	"00": "",
	
	"01": "",
	
	"02": "",
	
	"03": "",
	
	"punit": "APT",
	
	"finance": "058343",
	
	"DPVfoot_M1": "0",
	
	"DPVfoot_M3": "0",
	
	"Footnotes": "E#N#",
	
	"dadl3": "",
	
	"sec_code": "B",
	
	"postalcode": "",
	
	"dadl1": "1333 W GARVEY AVE N APT 120",
	
	"dadl2": "ACME INC",
	
	"mpnum": "1333",
	
	"punit2": "",
	
	"addon_low": "2280",
	
	"lacs": "",
	
	"izipc": "91790",
	
	"DPVfoot_N1": "0",
	
	"addon": "2280",
	
	"rdi": "Y",
	
	"DPVfoot_G1": "0",
	
	"psuf1": "AVE",
	
	"psuf2": "",
	
	"psnum2": "",
	
	"dstaa": "CA",
	
	"irecid": "1",
	
	"psnum": "120",
	
	"rec_type": "H",
	
	"DPVfoot_F1": "0",
	
	"county_name": "LOS ANGELES",
	
	"LlkInd": "",
	
	"congress_dist": "32",
	
	"sec_low": "00000107",
	
	"str_name": "GARVEY",
	
	"ppst1": "N",
	
	"state": "06",
	
	"municipality": "",
	
	"ppst2": "",
	
	"pmbnum": "",
	
	"DPVfoot_A1": "0",
	
	"abcty": "",
	
	"DPVfoot_P3": "0",
	
	"sec_high": "00000128",
	
	"DPVfoot_P1": "0",
	
	"prote": "C001",
	
	"icountry": "US",
	
	"dctya": "",
	
	"ictyi": "WEST COVINA",
	
	"addon_high": "2280",
	
	"dctys": "WEST COVINA",
	
	"suffix": "AVE",
	
	"misc": "",
	
	"unit": "APT",
	
	"respn": "3",
	
	"cris": "C001",
	
	"sec_name": "",
	
	"iprurb": "",
	
	"ppnum": "1333"
	
}],

"license": {

	"Total_Credits_Remaining": "47931154",
	
	"Annual_Credits_Remaining": "52083943"
	
},

"success": true

}

200 "success": false

{

	"message": "Invalid API Key",
	
	"success": false

}

CASS RESTful API JSON Object Value Descriptions:

JSON ObjectDESCRIPTION

0Reserved For Future Use

1Reserved For Future Use

2Reserved For Future Use

3Reserved For Future Use

4Reserved For Future Use

5Unofficial Po Name (1=MATCH; 0=NO Match)

AZip Corrected (1=MATCH; 0=NO Match) - The address was found to have a different 5-digit ZIP Code than input.

ABCTYStandardized City Abbreviation

ADDONZIP+4 Addon Code

ADDON_HIGHADD On High

ADDON_LOWADD On Low

BCity/State Corrected (1=MATCH; 0=NO Match) - The spelling of the city name and/or state abbreviation in the input address was found to be different than the standard spelling. The standard spelling of the city name and state abbreviation is shown in the DCTYS and DSTAA result values.

CInvalid City/State/Zip (1=MATCH; 0=NO Match) - The input ZIP Code could not be found because neither a valid city and state, nor valid 5-digit ZIP Code was present. Recommendation is that the customer check the accuracy of the submitted address.

CONGRESS_DISTCongressional District

COUNTY_NOFips County Code

COUNTY_NOCounty Number

CRISCarrier Route

DNo Zip Assigned (1=MATCH; 0=NO Match) - This is a record listed by the United States Postal Service as a non-deliverable location. Recommendation is that the customer check the accuracy of the submitted address.

DADL1Standardized Delivery Address

DADL2Standardized Firm Name

DADL3Standardized 2ND Delivery Address

DCTYAStandardized City

DCTYSMain Post Office City

DLASTStandardized City/State/Zip

DPBCDelivery Point Bar Code

DPVADPV 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.

YAddress was DPV confirmed for both primary and (if present) secondary numbers.

DAddress was DPV confirmed for the primary number only, and Secondary number information was missing.

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

NBoth Primary and (if present) Secondary number information failed to DPV Confirm.

BlankAddress not presented to hash table.

DPVCDPV CMRA Indicator Note: CMRA Indicates a private business that acts as a mail-receiving agent for specific clients.

YAddress was found in CMRA table.

NAddress was not found in CMRA table.

BlankAddress not presented to hash table.

DPVFDPV 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.

YAddress was found in False Positive table.

NAddress was not found in False Positive table.

BlankAddress not presented to hash table.

DPVFOOT_A1ZIP4 did not match (1=MATCH; 0=NO Match)

DPVFOOT_AAZIP4 matched (1=MATCH; 0=NO Match)

DPVFOOT_BBConfirmed entire address (1=MATCH; 0=NO Match)

DPVFOOT_CCConfirmed address by dropping secondary info (1=MATCH; 0=NO Match)

DPVFOOT_F1Military Match (1=MATCH; 0=NO Match)

DPVFOOT_G1General Delivery Match (1=MATCH; 0=NO Match)

DPVFOOT_M1Primary number missing from address (1=MATCH; 0=NO Match)

DPVFOOT_M3Could not confirm address (1=MATCH; 0=NO Match)

DPVFOOT_N1Confirmed a highrise or box type address w/o secondary info (1=MATCH; 0=NO Match)

DPVFOOT_P1Box type address missing box number (1=MATCH; 0=NO Match)

DPVFOOT_P3Box number invalid (1=MATCH; 0=NO Match)

DPVFOOT_R1Confirmed a highrise or box type address w/o secondary info (1=MATCH; 0=NO Match)

DPVFOOT_RRConfirmed address (1=MATCH; 0=NO Match)

DPVFOOT_U1Unique ZIP Code record (1=MATCH; 0=NO Match)

DPVVVacant 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.

YAddress was found in VACANT table.

NAddress was not found in VACANT table.

BlankAddress not presented to hash table.

DPVXDSF2 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.

YAddress was found in NOSTATS table.

NAddress was not found in NOSTATS table.

BlankAddress not presented to hash table.

DSTAAMain Post Office State

EZip Assigned For Mult Response (1=MATCH; 0=NO Match) - Multiple records were found, but each shares the same 5-digit ZIP Code. Recommendation is that the customer check the accuracy of the submitted address.

ELOT_CODEElot Ascending/Descending Flag

ELOT_NUMElot Number

FNo Zip Available (1=MATCH; 0=NO Match) - The address, exactly as input, could not be found in the city, state, or ZIP Code provided. Many factors contribute to this; either the primary number is missing, the street is missing, or the street is too horribly misspelled to understand. Recommendation is that the customer check the accuracy of the submitted address.

FINANCEFinance Code

FOOTNOTESFootnote String

A# : Corrected ZIP Code The address was found to have a different 5-digit ZIP Code than given in the submitted list. The correct ZIP Code is shown in the ZIP Code field. 

B# : Fixed city/state spelling The spelling of the city name and/or state abbreviation in the submitted address was found to be different than the standard spelling. The standard spelling of the city name and state abbreviation is shown in the City and State fields. 

C#: Invalid city/state/ZIP The ZIP Code in the submitted address could not be found because neither a valid city and state, nor valid 5-digit ZIP Code was present. Recommendation is that the customer check the accuracy of the submitted address. 

D#: No ZIP+4 assigned This is a record listed by the United States Postal Service as a non-deliverable location. Recommendation is that the customer check the accuracy of the submitted address. 

E#: Same ZIP for multiple Multiple records were returned, but each shares the same 5-digit ZIP Code. 

F# : Address not found The address, exactly as submitted, could not be found in the city, state, or ZIP Code provided. Many factors contribute to this; either the primary number is missing, the street is missing, or the street is too horribly misspelled to understand. 

G# : Used firm data Information in the firm line was determined to be a part of the address. It was moved out of the firm line and incorporated into the address line. 

H# : Missing secondary number ZIP+4 information indicates that this address is a building. The address as submitted does not contain a secondary (apartment, suite, etc.) number. Recommendation is that the customer check the accuracy of the submitted address and add the missing secondary number to ensure the correct Delivery Point Barcode (DPBC). 

I# : Insufficient/ incorrect address data More than one ZIP+4 Code was found to satisfy the address as submitted. The submitted address did not contain sufficiently complete or correct data to determine a single ZIP+4 Code. Recommendation is that the customer check the accuracy and completeness of the submitted address. For example, a street may have a similar address at both the north and south ends of the street. 

J# : Dual address The input contained two addresses. For example: 123 MAIN ST PO BOX 99. 

K# : Cardinal rule match The cardinal direction (North, South, East, West) was changed in order to obtain a match. While the output address is valid, it may not be the intended address, so be aware. 

L# : Changed address component An address component (i.e., directional or suffix only) was added, changed, or deleted in order to achieve a match.

LL# or LI# : Flagged address for LACSLink The input address matched a record that was LACS-indicated, that was submitted to LACSLink for processing. This does not mean that the address was converted; it only means that the address was submitted to LACSLink because the input address had the LACS indicator set.

M# : Fixed street spelling The spelling of the street name was changed in order to achieve a match. 

N# : Fixed abbreviations The delivery address was standardized. For example, if STREET was in the delivery address, the Toolkit will return ST as its standard spelling. 

O# : Multiple ZIP+4; lowest used More than one ZIP+4 Code was found to satisfy the address as submitted. The lowest ZIP+4 add-on may be used to break the tie between the records. 

P# : Better address exists The delivery address is matchable, but it is known by another (preferred) name. For example, in New York, NY, AVENUE OF THE AMERICAS is also known as 6TH AVE. An inquiry using a delivery address of 39 6th Avenue would be flagged with Footnote P. 

Q# : Unique ZIP match Match to an address with a unique ZIP Code, so any address entry is considered valid. `

R# : No match; EWS: Match soon The delivery address is matchable, but the Early Warning System file indicates that an exact match will be available soon. 

S# : Bad secondary address The secondary information (apartment, suite, etc.) does not match that on the national ZIP+4 file. The secondary information, although present on the input address, was not valid in the range found on the national ZIP+4 file. 

T# : Multiple response due to magnet street syndrome The search resulted in a single response; however, the record matched was flagged as having magnet street syndrome, and the input street name components (pre-directional, primary street name, post-directional, and suffix) did not exactly match those of the record. A "magnet street" is one having a primary street name that is also a suffix or directional word, having either a post-directional or a suffix (i.e., 2220 PARK MEMPHIS TN logically matches to a ZIP+4 record 2200-2258 PARK AVE MEMPHIS TN 38114-6610), but the input address lacks the suffix "AVE" which is present on the ZIP+4 record. The primary street name "PARK" is a suffix word. The record has either a suffix or a post-directional present. Therefore, in accordance with CASS requirements, a ZIP+4 Code must not be returned. The multiple response return code is given since a "no match" would prevent the best candidate. 

U# : Unofficial post office name The city or post office name in the submitted address is not recognized by the United States Postal Service as an official last line name (preferred city name), and is not acceptable as an alternate name. The preferred city name is included in the City field. 

V# : Unverifiable city / state The city and state in the submitted address could not be verified as corresponding to the given 5-digit ZIP Code. This comment does not necessarily denote an error; however, the recommendation is that the customer check the accuracy of the city and state in the submitted address. 

W# : Invalid delivery address The input address record contains a delivery address other than a PO Box, General Delivery, or Postmaster 5-digit ZIP Code that is identified as a "small town default". The USPS does not provide street delivery service for this ZIP Code. The USPS requires the use of a PO Box, General Delivery, or Postmaster for delivery within this ZIP Code. 

X# : Unique ZIP Code Default match inside a unique ZIP Code 

Y# : Military match Match made to a record with a military ZIP Code. `

Z# : Matched with ZIPMOVE The ZIPMOVE product shows which ZIP+4 records have moved from one ZIP Code to another. If an input address matches a ZIP+4 record which the ZIPMOVE product indicates has moved, the search is performed again in the new ZIP Code.

GPart Of Firm Moved To Address (1=MATCH; 0=NO Match) - Information in the firm line was determined to be a part of the input address. It was moved out of the firm name and incorporated into the standardized address line.

HSecondary Number Missing (1=MATCH; 0=NO Match) - ZIP+4 information indicates that this address is a building (high-rise). The address as input does not contain a secondary (apartment, suite, etc.) number. Recommendation is that the customer check the accuracy of the submitted address and add the missing secondary number to ensure the correct Delivery Point Barcode (DPBC).

IInsufficient/Incorrect Data (1=MATCH; 0=NO Match) - More than one ZIP+4 Code was found to satisfy the address as submitted. The submitted address did not contain sufficiently complete or correct data to determine a single ZIP+4 Code. Recommendation is that the customer check the accuracy and completeness of the submitted address. For example, a street may have a similar address at both the north and south ends of the street.

IADL1Input Delivery Address

IADL2Input Firm Name

IADL3Input Second Address Line

ICTYIInput City

IPRURBInput Urbanization Name

IRECIDInput Record ID

ISTAIInput State

IZIPCInput ZIP+4 Code

JDual Input (1=MATCH; 0=NO Match) - The input contained two addresses. For example: 123 MAIN ST PO BOX 99.

KMulti Caused By Cardinal Rule (1=MATCH; 0=NO Match) - The cardinal direction (North, South, East, West) was changed in order to obtain a match. While the output address is valid, it may not be the intended address, so be aware.

LDel Addr Component Add/Del/Chg (1=MATCH; 0=NO Match) - An address component (i.e., directional or suffix only) was added, changed, or deleted in order to achieve a match.

LLKRCLacs Link Return Code

LACSLacs Converted Status

LLKINDLacs Link Indicator

MStreet Name Spelling Changed (1=MATCH; 0=NO Match) - The spelling of the street name was changed in order to achieve a match.

MISCReserved For Future Use

MPNUMMatched Primary Number

MSNUMMatched Secondary Number

MUNICIPALITYMunicip. City/State Key (not Filled)

NDelivery Addr Was Standardized (1=MATCH; 0=NO Match) - The delivery address was standardized. For example, if 'STREET' was in the delivery address, the AccuZIP CASS RESTful API will return 'ST' as its standard spelling.

OLow +4 Tie-Breaker (multi-Response) (1=MATCH; 0=NO Match) - More than one ZIP+4 Code was found to satisfy the address as input. The lowest ZIP+4 add-on may be used to break the tie between the records.

PBetter Delivery Address Exists (1=MATCH; 0=NO Match) - The delivery address is matchable, however, it is known by another (preferred) name. For example, in New York, NY, AVENUE OF THE AMERICAS is also known as 6TH AVE. An inquiry using a delivery address of 39 6th Avenue would be flagged with Footnote P.

PMBPMB Unit Designator

PMBNUMPMB Number

POST_DIRPost-Direction Abbrev

PPNAMPrimary Name

PPNUMPrimary Number

PPRE1First or Left Pre-Direction

PPRE2Second or Right Pre-Direction

PPST1First or Left Post-Direction

PPST2Second or Right Post-Direction

PRE_DIRPre-Direction Abbrev

PROTERural Route Number

PSNUMSecondary Number

PSNUM2Matched Secondary Number

PSUF1First or Left Suffix

PSUF2Second or Right Suffix

PUNITSecondary Number Unit

PUNIT2Secondary Number Unit

QUnique Zip Code (1=MATCH; 0=NO Match) - Match to an address with a unique ZIP Code, so any address entry is considered valid. In this scenario, no input address is necessary since all of the mail for Unique ZIP Codes are recieved at one address.

RNo Match Due To Ews (1=MATCH; 0=NO Match) - The delivery address is matchable, but the Early Warning System file indicates that an exact match will be available soon.

REC_TYPERecord Type

RESPNNumber Of Returned Responses

RETCCReturn Code

SInvalid Secondary Number (1=MATCH; 0=NO Match) - The secondary information (apartment, suite, etc.) does not match that on the national ZIP+4 file. The secondary information, although present on the input address, was not valid in the range found on the national ZIP+4 file.

SEC_CODESecondary Even Odd Code

SEC_HIGHSecondary High Range

SEC_LOWSecondary Low Range

SEC_NAMEBLDG or Firm Name

STATEState Abbreviation (not Filled)

STELNKINDStelnk Footnote

STR_NAMEStreet Name

SUFFIXSuffix Abbrev

TMultiple Caused By Magnet Rule (1=MATCH; 0=NO Match) - The search resulted in a single response; however, the record matched was flagged as having magnet street syndrome, and the input street name components (pre-directional, primary street name, post-directional, and suffix) did not exactly match those of the record. A "magnet street" is one having a primary street name that is also a suffix or directional word, having either a post-directional or a suffix (i.e., 2220 PARK MEMPHIS TN logically matches to a ZIP+4 record 2200-2258 PARK AVE MEMPHIS TN 38114-6610), but the input address lacks the suffix "AVE" which is present on the ZIP+4 record. The primary street name "PARK" is a suffix word. The record has either a suffix or a post-directional present. Therefore, in accordance with CASS requirements, a ZIP+4 Code must not be returned. The multiple response return code is given since a "no match" would prevent the best candidate.

UUnofficial Po Name (1=MATCH; 0=NO Match) - The city or post office name in the input address is not recognized by the United States Postal Service as an official last line name (preferred city name), and is not acceptable as an alternate name. The preferred city name is included in the City field.

UNITSecondary Abbreviation

VUnverifiable City/State (1=MATCH; 0=NO Match) - The city and state in the input address could not be verified as corresponding to the given 5-digit ZIP Code. This comment does not necessarily denote an error; however, the recommendation is that the customer check the accuracy of the city and state in the submitted address.

WSmall Town Default (1=MATCH; 0=NO Match) - The input address record contains a delivery address other than a PO Box, General Delivery, or Postmaster 5-digit ZIP Code that is identified as a "small town default". The USPS does not provide street delivery service for this ZIP Code. The USPS requires the use of a PO Box, General Delivery, or Postmaster for delivery within this ZIP Code.

XUnique Zip Code Generated (1=MATCH; 0=NO Match) - Default match inside a unique ZIP Code

YMilitary Match (1=MATCH; 0=NO Match) - Match made to a record with a military ZIP Code.

ZZip Move Match (1=MATCH; 0=NO Match) - The ZIPMOVE product shows which ZIP+4 records have moved from one ZIP Code to another. If an input address matches a ZIP+4 record which the ZIPMOVE product indicates has moved, the search is performed again in the new ZIP Code.

ZIPC5-DIGIT Zip Code

RDIResidential Delivery Indicator

YResidential Delivery

NNot Residential Delivery

blankDid not query RDI Table