Skip to main content
POST
phone.number.identity-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
country
string
required

Two-letter country code.

Pattern: ^[A-Z]{2}$
streetAddress
string
required

Street address including building number.

Required string length: 1 - 500
locality
string
required

City or town.

Required string length: 1 - 200
postalCode
string
required

Postal code.

Required string length: 1 - 40
extendedAddress
string

Apartment, suite or unit.

Maximum string length: 200
administrativeArea
string

State or region.

Maximum string length: 200

Response

The result

valid
boolean
required

Whether validation passed.

skipped
boolean
required

No region was supplied, so early validation did not run.