Initiate Verification
Start the caller ID verification flow by sending an OTP to a phone number.
Initiate Verification
Begin verifying a phone number. TryVox generates a 6-digit OTP and delivers it to the number via voice call (default) or SMS. The number is recorded as pending until the OTP is submitted via Submit OTP.
Endpoint
POST https://api.tryvox.io/v1/voice/accounts/{auth_id}/verified-caller-idsRequest body
| Parameter | Type | Required | Description |
|---|---|---|---|
phone_number | string | yes | E.164-formatted number to verify (e.g., +919876543210) |
alias | string | no | Friendly label for this caller ID. Returned on subsequent reads. |
channel | string | no | call or sms. Default: call. |
Example request
curl -X POST https://api.tryvox.io/v1/voice/accounts/$TRYVOX_AUTH_ID/verified-caller-ids \
-u $TRYVOX_AUTH_ID:$TRYVOX_AUTH_TOKEN \
-H "Content-Type: application/json" \
-d '{
"phone_number": "+919876543210",
"alias": "Office line",
"channel": "call"
}'Response
201 Created:
{
"id": "8f7a4b2e-91c2-4f3d-9a1e-2c4b6d8f0a1c",
"phone_number": "+919876543210",
"verification_status": "pending",
"message": "Verification code sent via call to +919876543210"
}Response fields
id— UUID of the caller ID record. Use it as a stable handle in your own systems.phone_number— the number being verified, echoed back.verification_status— alwayspendingon first initiation.message— human-readable confirmation of the delivery channel.
Behavior
- Re-initiation while pending: allowed. Submitting a new request for the same
phone_numberresets the OTP to a fresh value. The old OTP becomes invalid. - Already verified: if the number is already
verifiedon this account, the API returns409 ALREADY_VERIFIEDinstead of issuing a new OTP. Delete the entry first if you want to re-verify. - OTP delivery latency: voice OTPs typically arrive within 5–10 seconds; SMS within 30 seconds depending on carrier.
- OTP lifetime: valid until a new initiation is requested for the same number.
Errors
| Status | Code | Reason |
|---|---|---|
| 400 | VALIDATION_FAILED | phone_number missing or not E.164 |
| 401 | INVALID_CREDENTIALS | Auth ID / Auth Token bad |
| 403 | FORBIDDEN | Auth ID in URL doesn't match the authenticated key |
| 409 | ALREADY_VERIFIED | Number is already verified on this account |