Skip to main content
POST
phone.number.identity.submit

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
confirm
boolean
required

Confirm identity submission and recurring rent after activation.

areaCode
string

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

Pattern: ^\d{1,4}$
values
object[]

Up to 50 identity values needed for the submission job.

Maximum array length: 50
documents
object[]

Up to four uploaded documents, each at most 3 MB; one-side IDs must be combined before upload.

Maximum array length: 4
address
object
endUserFirstName
string

Legal first name for an identity check.

Required string length: 1 - 100
endUserLastName
string

Legal last name for an identity check.

Required string length: 1 - 100
preOrder
boolean
default:false

Accept sourcing when the requested area is sold out.

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.