addressVerificationInformation
The following fields are related to address verification.
addressVerificationInformation. addressType
Contains the record type of the postal code to which the
address was matched.
U.S. Addresses
: Depending on the quantity and quality of the address information provided,
this field contains one or two characters:- One character: Sufficient correct information was provided to result in accurate matching.
- Two characters: Standardization would provide a better address if more or better input address information was available. The second character isD(default).
Blank fields are unassigned. When an address cannot be standardized, the
parsing of the input data determines the address type. In this case, standardization
can indicate a street, rural route, highway contract, general delivery, or PO box.
These address type codes are returned:
Code | Description |
---|---|
F | Firm. |
G | General delivery. |
H | High-rise apartment or office building. |
M | Military. |
P | Post office box. |
R | Rural route or highway contract. |
S | Street (usually one side of one city block). |
FD | Firm default. The standardization process could not
assign a firm extended ZIP code. |
GD | General delivery default. Assigned when general
delivery is the only primary name listed for the ZIP code. |
HD | High-rise default. The standardization process assigned
the extended ZIP code for the entire building. Assignment at the
unit, floor, or wing level is possible. A suite or apartment number
could be out of range. |
RD | Rural route or highway contract default. The
standardization process assigned the extended ZIP code for the
entire route, but it was unable to assign the box number. |
SD | Street default. The standardization process assigned
the extended ZIP code for the block because there was no extended
ZIP code for the building. |
SR | Street served by route. |
UD | Unique default. The owner of the ZIP code did not
assign extended ZIP codes, or the address was not matched. |
All Other Countries
: This field contains one of these values:- P: Post
- S: Street
- X: Unknown
Specifications
- Data Type:String
- Data Length:255
Mapping Information
- REST API Field:addressVerificationInformation.addressType
- SCMP API Field:dav_address_type
- Simple Order API Field:davReply_addressType
addressVerificationInformation. applicableRegion
The regional location of the delivery address.
Possible values include:
- Canada
- International
- US
The values of the error codes and status codes mean different things depending on the applicable region.
Specifications
- Data Type:String
- Data Length:255
Mapping Information
- REST API Field:addressVerificationInformation.applicableRegion
- SCMP API Field:No corresponding field
- Simple Order API Field:No corresponding field
addressVerificationInformation. barCode.checkDigit
Check digit for the 11-digit delivery point barcode.
Specifications
- Data Type:Non-negative integer
- Data Length:1
Mapping Information
- REST API Field:addressVerificationInformation.barCode.checkDigit
- SCMP API Field:dav_bar_code_chkdigit
- Simple Order API Field:davReply_barCodeCheckDigit
addressVerificationInformation. barCode.value
Delivery point bar code determined from the input address.
Specifications
- Data Type:String
- Data Length:255
Mapping Information
- REST API Field:addressVerificationInformation.barCode.value
- SCMP API Field:dav_bar_code
- Simple Order API Field:davReply_barCode
addressVerificationInformation. careOf
Care of data dropped from the standard address.
Specifications
- Data Type:String
- Data Length:255
Mapping Information
- REST API Field:addressVerificationInformation.careOf
- SCMP API Field:dav_careof
- Simple Order API Field:davReply_careOf
addressVerificationInformation. errorCode
Four-character error code returned for Canadian or international addresses.
Specifications
- Data Type:String
- Data Length:255
Mapping Information
- REST API Field:addressVerificationInformation.errorCode
- SCMP API Fields:
- dav_ca_error_info(Canadian)
- dav_intl_error_info(international)
- dav_us_error_info(US)
- Simple Order API Fields:
- davReply_caErrorInfo(Canadian)
- davReply_intlErrorInfo(international)
- davReply_usErrorInfo(US)
addressVerificationInformation. matchScore
Indicates the probable correctness of the address match.
Returned for U.S. and Canadian addresses. Returns a value from
0-9
, where 0
is most likely to be correct and 9
is least likely to be correct, or -1
if there is no address match.Specifications
- Data Type:Integer
- Data Length:1
Mapping Information
- REST API Field:addressVerificationInformation.matchScore
- SCMP API Field:dav_match_score
- Simple Order API Field:davReply_matchScore
addressVerificationInformation. standardAddress.address1.
withApartment
First line of the standardized address, including apartment information.
Specifications
- Data Type:String
- Data Length:255
Mapping Information
- REST API Field:addressVerificationInformation.standardAddress.address1.withApartment
- SCMP API Field:dav_standard_address
- Simple Order API Field:davReply_standardizedAddress1
addressVerificationInformation. standardAddress.address1. withoutApartment
First line of the standardized address, without apartment information.
Returned for US and Canadian addresses.
Specifications
- Data Type:String
- Data Length:255
Mapping Information
- REST API Field:addressVerificationInformation.standardAddress.address1.withoutApartment
- SCMP API Field:dav_standard_address_noapt
- Simple Order API Field:davReply_standardizedAddressNoApt
addressVerificationInformation. standardAddress.address2
Second line of the standardized address.
Specifications
- Data Type:String
- Data Length:255
Mapping Information
- REST API Field:addressVerificationInformation.standardAddress.address2
- SCMP API Field:dav_standard_address2
- Simple Order API Field:davReply_standardizedAddress2
addressVerificationInformation. standardAddress.address3
Third line of the standardized address.
Specifications
- Data Type:String
- Data Length:255
Mapping Information
- REST API Field:addressVerificationInformation.standardAddress.address3
- SCMP API Field:dav_standard_address3
- Simple Order API Field:davReply_standardizedAddress3
addressVerificationInformation. standardAddress.address4
Fourth line of the standardized address.
Specifications
- Data Type:String
- Data Length:255
Mapping Information
- REST API Field:addressVerificationInformation.standardAddress.address4
- SCMP API Field:dav_standard_address4
- Simple Order API Field:davReply_standardizedAddress4
addressVerificationInformation. standardAddress.administrativeArea
United States Postal Service standardized state or province
abbreviation.
Specifications
- Data Type:String
- Data Length:255
Mapping Information
- REST API Field:addressVerificationInformation.standardAddress.administrativeArea
- SCMP API Field:dav_standard_state
- Simple Order API Field:davReply_standardizedState
addressVerificationInformation. standardAddress.country
Standardized country or region name.
Specifications
- Data Type:String
- Data Length:255
Mapping Information
- REST API Field:addressVerificationInformation.standardAddress.country
- SCMP API Field:dav_standard_country
- Simple Order API Field:davReply_standardizedCountry
addressVerificationInformation. standardAddress.county
US county, if available.
Specifications
- Data Type:String
- Data Length:255
Mapping Information
- REST API Field:addressVerificationInformation.standardAddress.county
- SCMP API Field:dav_standard_county
- Simple Order API Field:davReply_standardizedCounty
addressVerificationInformation. standardAddress.csz
Standardized city, state, or province and ZIP + 4 code or postal code line.
Specifications
- Data Type:String
- Data Length:255
Mapping Information
- REST API Field:addressVerificationInformation.standardAddress.csz
- SCMP API Field:dav_standard_csz
- Simple Order API Field:davReply_standardizedCSP
addressVerificationInformation. standardAddress.iso.Country
Standardized two-character ISO country or region code.
Specifications
- Data Type:String
- Data Length:255
Mapping Information
- REST API Field:addressVerificationInformation.standardAddress.iso.Country
- SCMP API Field:dav_standard_iso_country
- Simple Order API Field:davReply_standardizedISOCountry
addressVerificationInformation. standardAddress.locality
Standardized city name.
Specifications
- Data Type:String
- Data Length:255
Mapping Information
- REST API Field:addressVerificationInformation.standardAddress.locality
- SCMP API Field:dav_standard_city
- Simple Order API Field:davReply_standardizedCity
addressVerificationInformation. standardAddress.postalCode
Standardized US ZIP + 4 postal code.
Specifications
- Data Type:String
- Data Length:10
Mapping Information
- REST API Field:addressVerificationInformation.standardAddress.postalCode
- SCMP API Field:dav_standard_zip
- Simple Order API Field:davReply_standardizedPostalCode
addressVerificationInformation. statusCode
Four-to-ten-character status code.
Specifications
- Data Type:String
- Data Length:255
Mapping Information
- REST API Field:addressVerificationInformation.statusCode
- SCMP API Fields:
- dav_ca_info
- dav_intl_info
- dav_us_info
- Simple Order API Fields:
- davReply_caInfo
- davReply_intlInfo
- davReply_usInfo