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

Legal business name on the identity certificate.

Required string length: 1 - 200
gstRegistered
boolean
required

Whether the business is registered for goods and services tax.

documentKind
enum<string>
required

Certificate kind; GST exactly when registered.

Available options:
gst,
incorporation,
udyam
fileId
string
required

Id of an uploaded file holding one business identity certificate: PDF, JPG or PNG, at most 5 MB, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
filename
string
required

Certificate filename, up to 99 characters, without path or quotation marks.

Required string length: 1 - 99
Pattern: ^[^\r\n"\\/]+$
confirm
boolean
required

Confirm submission to the numbering authority in your business's name; cannot be withdrawn.

Response

The result

status
enum<string>
required

Business review state; no application returns not_found.

Available options:
in_review,
approved,
rejected,
suspended,
expired
canRent
boolean
required

Whether this business is approved to rent a local number.

submittedAt
string<date-time>
required

When the business application was submitted.

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))$
reviewNote
string

Untrusted instructions for correcting a rejected application.

Maximum string length: 2000