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

The phone number, international (E.164) or national format.

Required string length: 1 - 32
Pattern: ^(?:^\+?[0-9 ()-]{6,32}$)$
country
string

Two-letter country to read a national-format number against, e.g. US.

Pattern: ^[a-z]{2}$

Response

The result

valid
boolean
required

True when the number is a valid, dialable number.

lineType
string

Kind of line, e.g. mobile, landline or voip, when the source knows.

countryCode
string

Country of the number, two letters.

e164
string

The number in E.164 format.

international
string

The number in international display format.