Skip to content
Get started

Address Verification

Standard Address Verification API.

Provides endpoints to verify and standardize addresses across US and Canada, supporting both structured and freeform inputs.

Note that this uses a different set of lookups than our international API.

Verify
client.addressVerification.verify(AddressVerificationVerifyParamsparams, RequestOptionsoptions?): AddressVerificationVerifyResponse { data, message, status }
POST/v1/addver/verifications
ModelsExpand Collapse
Errors { city, generic, line1, 2 more }

Errors encountered during address verification.

city?: Array<string>

Errors related to the city.

generic?: Array<string>

Generic errors not tied to a specific field.

line1?: Array<string>

Errors related to the first address line.

line2?: Array<string>

Errors related to the second address line.

provinceOrState?: Array<string>

Errors related to the province or state.

Status = "verified" | "corrected" | "failed"

The verification status of an address.

One of the following:
"verified"
"corrected"
"failed"