Skip to main content
POST
companies.license.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
country
string
required

Registry country.

Allowed value: "IN"
licenseKind
enum<string>
required

Business licence kind.

Available options:
food,
shop
licenseNumber
string
required

Licence number.

Required string length: 1 - 1024
state
string

State for a shop licence.

Required string length: 1 - 1024
businessName
string

Business name for a shop licence.

Required string length: 1 - 1024
district
string

District for a shop licence.

Required string length: 1 - 1024
commencementDate
string

Date in YYYY-MM-DD format.

Pattern: ^\d{4}-\d{2}-\d{2}$
registrationDate
string

Date in YYYY-MM-DD format.

Pattern: ^\d{4}-\d{2}-\d{2}$

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.