Verify Address

Verify Address

POST https://api.synapsefi.com/v3.1/address-verification

This endpoint allows you to verify an address.

Headers

Name
Type
Description

Content-Type

string

This value should be application/jsonon

Request Body

Name
Type
Description

address_street

string

Street address associated with the document owner. This can be the home address of a person or business address of a corp. Please include apartment suite or unit numbers.

address_city

string

City associated with the document owner. This can be the home address of a person or business address of a corp.

address_subdivision

string

State abbreviation associated with the document owner. This value needs to be in ISO Alpha-2 (e.g. CA)

address_postal_code

string

Country associated with the document owner. This can be the home address of a person or business address of a corp. This value needs to be in ISO Alpha-2 (e.g. US)

address_country_code

string

Postal code associated with the document owner. This can be the home address of a person or business address of a corp.

{
    "deliverability": "usps_deliverable",
    "deliverability_analysis": {
        "partial_valid": false,
        "primary_number_invalid": false,
        "primary_number_missing": false,
        "secondary_invalid": false,
        "secondary_missing": false
    },
    "normalized_address": {
        "address_city": "SAN FRANCISCO",
        "address_country_code": "US",
        "address_postal_code": "94105",
        "address_street": "1 MARKET ST STE 500",
        "address_subdivision": "CA"
    }
}

Example Request

POST /v3.1/address-verification HTTP/1.1
Host: uat-api.synapsefi.com
Content-Type: application/json

{
    "address_street": "1 Market St. STE 500",
    "address_city": "San Francisco",
    "address_subdivision": "CA",
    "address_postal_code": "94105",
    "address_country_code": "US"
}

Deliverability

Deliverability Result

Description

deliverable

Check normalized_address object in response for deliverable address to use (e.g. in case "ST" supplied when deliverable address has "AVE")

usps_deliverable

Standard supplied address is a USPS deliverable address

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_unneccessary_unit

Address is deliverable but additional unit supplied when not necessary

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

Last updated