...
The API is Real Time and is able to validate addresses in real-time, allowing users to receive instant feedback on whether an address is valid or not
The API can detect if the address is a residential or business address, a deliverable address, a central delivery address or a vacant address
The API automatically corrects contents of address such as misspellings, no city name, incorrect zip code and it also formats the address compatible with USPS address standards
Auto populates the county code when applicable
Detects if the apartment number is missing from the address
Auto suggests a better address if available
API Details
FAVS API is a REST based API that takes the US address as the input and returns the corrected or proposed address as per validation.
Below is the sample Fenix Address Validation request and response.
...
Request
...
Response
...
| Code Block |
|---|
{
"requestId": "df3a89af-5de9-4051-82e8-040d9333adaf",
"address": {
"address1": "123 williams str",
"address2": null,
"city": "new york",
"state": "NY",
"country": "US",
"zipCode": "10001",
"zipCode4": null
}
}
|
...
| Code Block |
|---|
{
"requestId": "df3a89af-5de9-4051-82e8-040d9333adaf",
"originalAddress": {
"address1": "123 williams str",
"address2": null,
"city": "new york",
"state": "NY",
"country": null,
"zipCode": "10001",
"zipCode4": null
},
"recommendedAddress": {
"address1": "123 WILLIAM ST",
"address2": null,
"city": "NEW YORK",
"state": "NY",
"country": null,
"zipCode": "10038",
"zipCode4": "3804"
},
"metainfo": {
"vacant": false,
"business": false
},
"addressCorrections": [
{
"code": "ZIPCODE_CORRECTED",
"description": "Zip Code Corrected"
},
{
"code": "STREET_NAME_CHANGED",
"description": "Street Name changed"
}
],
"addressErrors": [
{
"code": "MISSING_SECONDARY_NUMBER",
"description": "Missing Apt/Unit Number"
}
],
"validationError": null
}
|
Flow
Retailers can integrate with Fenix Address Validation at three important places in the order flow.
...
Retailers can call FAVS API at the time of label printing to make sure the label is printed for the correct address. Printing labels for incorrect addresses can lead to delivery delays, additional shipping spend to correct addresses and in the worst case, return the package back to the warehouse.
API Details
Resource Name | Fenix Address Validation and Standardization | ||
Resource URL | /fenixaddressvalidate/api/v1/address/validate | ||
Method | POST | Params (query/path)||
Headers | store
| ||
Request Payload |
| ||
Response Payload |
| ||
Response Status | 200 - Success 400 - Failure |
Request Attribute Parameters
Attribute | Required | Description | ||
|---|---|---|---|---|
requestId | No | A random identifier that you send in each request | ||
address | Yes | The address that is to be validation | ||
address.address1 | Yes | The primary address line
| ||
address.address2 | No | Additional details about the address like building unit can be specified in address line 2 | ||
address.city | Yes | Name of the city | ||
address.state | Yes | State 2 letter code or full state name | ||
address.country | No | Two letter code of the country
| ||
address.zipCode | Yes | The zip code of the city | ||
address.zipCode4 | No | Represents 4 digit county code |
Response Attribute Parameters
Attribute | Required | Description | ||
|---|---|---|---|---|
requestId | No | A random identifier that you send in each request | ||
originalAddress | Yes | The address that is given as input to the API | ||
recommendedAddress | Yes | Fenix suggested address | ||
metainfo | Yes | Additional details of the suggested address | ||
metainfo.vacant | Yes | Represents whether the suggested address is vacant or not | ||
metainfo.business | Yes | Represents whether the suggested address is business or residential | ||
addressCorrections | No | Contains the corrections made to the input address | ||
addressCorrections.code | Yes | The correction code
| ||
addressCorrections.description | Yes | The description for the above code | ||
addressErrors | No | Represents additional errors in the address | ||
addressErrors.code | Yes | The address error codes
| ||
addressErrors.description | Yes | The description for the above code |