Response Samples
All the responses will include the original request and then the suggested address if it is found. The suggested address may or may not be verified.
validationMethod – displays which method was used for verification: FedEx®, USPS®, UPS® or Pacejet.
isVerified – this is a flag to determine if the address was completely validated. In some cases the address may be valid but was unable to definitively find a record match.
isVerifiedText – a note to indicate if there are any issues encountered with validating the address.
Error – displays specific error code and any other useful information about the error.
"error": {
"code": "AV1005",
"message": "Configuration for requested validation method not found",
"severity": "ERROR",
"source": "Post",
"moreInfo": null
} Included Attributes
AddressChangeCodes
FormattedAddress
AddressVerificationCodes
FedEx-included Attributes When Applicable
IsPOBox
POBoxOnlyZip
StreetPointNotValidated
StreetPointNotApplicable
ValidMultiUnit
Descartes Sample
{
"addressRequest": {
"validationMethod": "Descartes",
"licenseID": "9999999-9999999-999999-999999-9999",
"address1": "8760 Orion Pl",
"address2": "Suite 200",
"city": "Columbus",
"state": "OH",
"zip": "43240",
"country": "US"
},
"suggestedAddress": {
"address1": "8760 Orion Pl Ste 200",
"address2": "",
"city": "Columbus",
"state": "OH",
"zip": "43240-2109",
"country": "US",
"type": "Business",
"addressAttributes": [
{
"name": "FormattedAddress",
"value": "8760 Orion Pl Ste 200;Columbus OH 43240-2109"
},
{
"name": "Results",
"value": "AC16,AV25"
},
{
"name": "TransmissionResults",
"value": ""
},
{
"name": "AddressChangeCodes",
"value": "AC16"
},
{
"name": "AddressChangeCode",
"value": "AC16: The subadministrative area was added or changed."
},
{
"name": "AddressVerificationCodes",
"value": "AV25"
},
{
"name": "AddressVerificationCode",
"value": "AV25: Validated to the suite/apartment or PO Box"
}
]
},
"isVerified": true,
"isVerifiedText": "Verified",
"error": null
}FedEx sample
{
"addressRequest": {
"validationMethod": "FedEx",
"licenseID": "9999999-9999999-999999-999999-9999",
"address1": "8760 Orion Pl",
"address2": "Suite 200",
"city": "Columbus",
"state": "OH",
"zip": "43240",
"country": "US"
},
"suggestedAddress": {
"address1": "8760 ORION PL",
"address2": "STE 200",
"city": "COLUMBUS",
"state": "OH",
"zip": "43240-2109",
"country": "US",
"type": "Commercial",
"addressAttributes": [
{
"name": "ValidMultiUnit",
"value": "true"
}
]
},
"isVerified": true,
"isVerifiedText": null,
"error": null
}
UPS sample
{
"addressRequest": {
"validationMethod": "UPS",
"licenseID": "9999999-9999999-999999-999999-9999",
"address1": "8760 Orion Pl",
"address2": "Suite 200",
"city": "Columbus",
"state": "OH",
"zip": "43240",
"country": "US"
},
"suggestedAddress": {
"address1": "8760 ORION PL",
"address2": "STE 200",
"city": "COLUMBUS",
"state": "OH",
"zip": "43240-2109",
"country": "US",
"type": "Commercial",
"addressAttributes": []
},
"isVerified": true,
"isVerifiedText": null,
"error": null
}