Skip to main content
POST
address.verify

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
street
string
required

The street address's first line.

Required string length: 1 - 256
city
string

The address's city.

Required string length: 1 - 128
postalCode
string

The address's postal code.

Required string length: 1 - 16
stateCode
string

The address's state or province code, e.g. CA.

Required string length: 1 - 8

Response

The result

valid
boolean
required

Whether the address checks out.

street
string

The cleaned street address's first line.

city
string

The cleaned city.

stateCode
string

The cleaned state or province code.

postalCode
string

The cleaned postal code.

countryCode
string

The address's country code.

latitude
number

The address's latitude.

longitude
number

The address's longitude.

precision
string

How precisely the address could be placed.