Skip to main content
PUT
Send Business Details

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Headers

Thinnest-Workspace
string

Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace. Refused with 404 (Workspace not found.) when the id is unknown, is not one of your customers, or is not an org_… id; 410 when that customer was deleted (restore it with POST /customers/{id}/restore until it is erased); 403 when the key belongs to one customer workspace (it cannot act as another); 400 when your workspace is not a developer workspace. /customers/* and GET /customers/usage are your own workspace's and refuse the header with 400: call them without it.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Body

multipart/form-data
businessName
string
required

The business's legal name, as on its certificate.

Example:

"Acme Traders Private Limited"

gstRegistered
enum<string>
required

Whether the business is registered for GST.

Available options:
true,
false
document
file
required

The one certificate: PDF, JPG or PNG, at most 5 MB, filename at most 99 characters.

documentKind
enum<string>

Which certificate document is. Optional: gst when registered for GST, otherwise incorporation. When not registered it may be incorporation or udyam.

Available options:
gst,
incorporation,
udyam

Response

A rejected application was corrected and sent again, in place.

The workspace's application for Indian numbers. Only status is present when nothing has been sent (none).

status
enum<string>
required

none — nothing sent. submitted — being checked. accepted — approved. rejected — correct what reviewNote says and send again. suspended — approval withdrawn; no new number can be rented. expired — lapsed; send again. draft — started and never sent.

Available options:
none,
draft,
submitted,
accepted,
rejected,
suspended,
expired
Example:

"submitted"

businessName
string | null

The legal name the application was sent under; null if it could not be read just now.

Example:

"Acme Traders Private Limited"

gstRegistered
boolean | null

Whether the business said it is registered for GST.

documentKind
enum<string> | null

Which document was sent.

Available options:
gst,
incorporation,
udyam,
null
submittedAt
string<date-time>

When it was last sent.

reviewNote
string

Present on a rejected application: what to correct.

canRent
boolean

True when the details are approved, so an Indian number can be rented.