post https://uat-api.synapsefi.com/v3.1/address-verification
Check if an address is valid
Request Body
| Key | Type | Description |
|---|---|---|
| address_street | string | [Required] Street address associated with the document owner, this can be home address of a person or business address of a corp. Please include apartment suite or unit numbers |
| address_city | string | [Required] City associated with the document owner, this can be home address of a person or business address of a corp |
| address_subdivision | string | [Required] State abbreviation associated with the document owner. This value needs to be in ISO Alpha-2 (e.g. CA) |
| address_country_code | string | [Required] Country associated with the document owner, this can be home address of a person or business address of a corp. This value needs to be in ISO Alpha-2 (e.g. US) |
| address_postal_code | string | [Required] Postal code associated with the document owner, this can be home address of a person or business address of a corp |
Deliverability
- View Results in Right Panel for Example Responses
| Deliverability Result | Description |
|---|---|
✅ usps_deliverable | Standard supplied address is a USPS deliverable address. |
✅ deliverable | Address is deliverable based on supplemental check. Check normalized_address object in response for deliverable address to use (e.g. in case "ST" supplied when deliverable address has "AVE"). |
✅ deliverable_incorrect_unit | Base address is deliverable but supplied unit appears incorrect (e.g. actual unit number may be "APT 103" and original input may point to a non-existent unit like "APT 1003"). |
✅ deliverable_missing_unit | Base address is deliverable but expected unit was not supplied. Check normalized_address object in response for deliverable address to use. |
✅ deliverable_unnecessary_unit | Address is deliverable but additional unit supplied when not necessary. |
❌ google_undeliverable | User will not be verified, please try reentering or inputting a new address. |
Deliverability Analysis Object
| Key | Type | Description |
|---|---|---|
| deliverability_analysis. partial_valid | boolean | True if address is partially valid. |
| deliverability_analysis. primary_number_invalid | boolean | True if primary address number is invalid. |
| deliverability_analysis. primary_number_missing | boolean | True if primary address number is missing. |
| deliverability_analysis. secondary_invalid | boolean | True if secondary address line (e.g. unit) is invalid or unnecessary. |
| deliverability_analysis. secondary_missing | boolean | Secondary address line (e.g. unit) missing. |