Skip to main content
POST
geo.address.validate

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
address
string
required

Full address as free text.

Required string length: 1 - 512
countryCode
string

ISO 2-letter country code hint (optional).

Required string length: 1 - 20000

Response

The result

valid
boolean
required

True when valid.

confidence
number

Confidence.

latitude
number

Latitude.

longitude
number

Longitude.

componentsCity
string

Components city.

componentsCountry
string

Components country.

componentsCountryCode
string

Components country code.

componentsHouseNumber
string

Components house number.

componentsPostalCode
string

Components postal code.

componentsState
string

Components state.

componentsStreet
string

Components street.

formattedAddress
string

Formatted address.

inputAddress
string

Input address.

matchType
string

Match type.