Skip to main content
POST
phone.number.identity-link.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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}$
type
enum<string>
required

Kind of phone number.

Available options:
local,
mobile,
national,
toll_free
areaCode
string

Area code, one to four digits. A hard constraint when buying.

Pattern: ^\d{1,4}$
language
enum<string>

Hosted form language; otherwise browser language.

Available options:
en,
es,
pt-BR

Response

The result

url
string<uri>
required

One-use platform link to the identity form.

expiresAt
string<date-time>
required

Link expiry, no more than 24 hours away.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$