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

The person's full name.

Required string length: 1 - 256
phone
string
required

The phone number you hold for them.

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

The email address you hold for them.

Required string length: 1 - 320
street
string

First line of the postal address you hold for them.

Required string length: 1 - 256
city
string

City of that address.

Required string length: 1 - 128
postalCode
string

Postal code of that address.

Required string length: 1 - 16
country
string

Two-letter country of that address.

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

Response

The result

phoneValid
boolean

True when the phone number is valid.

phoneMatchesName
boolean

True when the phone number is registered to that name.

phoneLineType
string

Kind of line, e.g. mobile or landline.

emailValid
boolean

True when the email address is valid.

emailMatchesName
boolean

True when the email address is linked to that name.

addressValid
boolean

True when the postal address is valid.

addressMatchesName
boolean

True when the postal address is linked to that name.