Address Validation Example Request
POST {{base_url}}/api/addressvalidation/:version/:requestoption?regionalrequestindicator=True&maximumcandidatelistsize=20
This POST request can be used to validate a street level address in either the US or PR. Address classification can be done by changing the requestoption path parameter.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
regionalrequestindicator | string | Valid values: True or False. | |
| If True, either the region element or any combination of Political Division 1, Political Division 2, PostcodePrimaryLow and the PostcodeExtendedLow fields will be recognized for validation in addition to the urbanization element. | |||
| If False or no indicator, street level address validation is provided | |||
maximumcandidatelistsize | number | Valid values: 0 – 50 | |
| The maximum number of Candidates to return for this request. If not provided, the default size of 15 is returned. |
Request Body
{"XAVRequest"=>{"AddressKeyFormat"=>{"ConsigneeName"=>"RITZ CAMERA CENTERS-1749", "BuildingName"=>"Innoplex", "AddressLine"=>["26601 ALISO CREEK ROAD", "STE D", "ALISO VIEJO TOWN CENTER"], "Region"=>"ROSWELL,GA,30076-1521", "PoliticalDivision2"=>"ALISO VIEJO", "PoliticalDivision1"=>"CA", "PostcodePrimaryLow"=>"92656", "PostcodeExtendedLow"=>"1521", "Urbanization"=>"porto arundal", "CountryCode"=>"US"}}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"XAVResponse":{"Response":{"ResponseStatus":{"Code":"1","Description":"Success"}},"ValidAddressIndicator":"","Candidate":{"AddressKeyFormat":{"AddressLine":"12380 MORRIS RD","PoliticalDivision2":"ALPHARETTA","PoliticalDivision1":"GA","PostcodePrimaryLow":"30005","PostcodeExtendedLow":"4616","Region":"ALPHARETTA GA 30005-4616","CountryCode":"US"}}}}