DashboardGet started
DocumentationAPI ReferenceSDK Reference
DID Routing

Select a number

Reserve a number from the catalog and start a provisioning job. Returns the job — use its `id` for the remaining steps of the flow.

POST
/dids/managed/select

Reserve a number from the catalog and start a provisioning job. Returns the job — use its id for the remaining steps of the flow.

Authorization

ApiKeyAuth
X-API-Key<token>

Voice platform authentication secret. Create one from the API Keys endpoint or your dashboard.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/dids/managed/select" \  -H "Content-Type: application/json" \  -d '{    "didId": 48213,    "didType": "mobile"  }'
{  "id": "job_9f2ka",  "status": "number_locked",  "selectedDidNumber": "+911408620000",  "steps": [    {      "label": "Number reserved",      "status": "completed"    },    {      "label": "KYC verified",      "status": "current"    },    {      "label": "Number purchased & assigned",      "status": "pending"    },    {      "label": "Inbound routing configured",      "status": "pending"    },    {      "label": "Status webhook configured",      "status": "pending"    },    {      "label": "Ready for inbound calls",      "status": "pending"    }  ]}
{  "statusCode": 400,  "message": [    "name should not be empty"  ],  "error": "Bad Request"}
{  "statusCode": 401,  "message": "Unauthorized",  "error": "Unauthorized"}

List numbers GET

Retrieve every phone number connected to the workspace — both numbers you brought yourself (`mode: byo`) and managed business numbers provisioned through our carrier partner (`mode: managed`).

Start Aadhaar verification POST

Begin Aadhaar identity verification for the job. Returns an `aadhaarRedirectUrl` pointing to DigiLocker (the Indian government's document service) — send the applicant there to consent and complete verification, then poll the job until its status reaches `kyc_verified`.