Skip to main content
POST
geo.address.validate-detailed

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
object
required

Postal address to validate, personal data.

enablePostalCertification
boolean
default:false

Request postal certification where supported.

englishLatin
boolean
default:false

Request an English Latin-script address.

Response

The result

formattedAddress
string
required

Corrected address.

Required string length: 1 - 2048
complete
boolean
required

Whether all address components are present.

components
object[]
required

Component verdicts.

Maximum array length: 40
inputGranularity
string

Input precision.

Required string length: 1 - 80
validationGranularity
string

Validated precision.

Required string length: 1 - 80
geocodeGranularity
string

Coordinate precision.

Required string length: 1 - 80
location
object

Coordinates.

residential
boolean

Residential address.

business
boolean

Business address.

postalConfirmation
string

Postal delivery confirmation.

Required string length: 1 - 80
englishLatinAddress
string

English Latin-script address.

Required string length: 1 - 2048
ref
string

Reference to what this call created. Pass it as ref to geo.address.validation-feedback.send.