Auth
Create a new customer account (self-service signup).
Initiates a new customer account registration. The request must include accepted_tos: true to confirm Terms of Service agreement.
On success, returns a customer object and a provisioned access key. On failure (e.g., duplicate email), still returns HTTP 200 with an empty body to prevent email enumeration attacks.
After signup, the customer receives a verification email. Use POST /auth/email-verify with the token from the email to verify the account.
post/auth/signup
Request body
Example request
{
"name": "Acme Corporation",
"detail": "Enterprise customer account",
"email": "admin@acme.com",
"phone_number": "+14155551234",
"address": "123 Main St, San Francisco, CA 94105",
"webhook_method": "POST",
"webhook_uri": "https://api.acme.com/webhooks/voipbin",
"accepted_tos": true
}Response
Signup initiated successfully, or silently ignored if the email already exists (to prevent enumeration). On success, the response contains the customer object and a provisioned access key. On failure, the response body is an empty JSON object {}.
Example response
{
"customer": {
"id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
"name": "Acme Corporation",
"detail": "Enterprise customer account",
"email": "admin@acme.com",
"phone_number": "+14155551234",
"address": "123 Main St, San Francisco, CA 94105",
"webhook_method": "POST",
"webhook_uri": "https://api.acme.com/webhooks/voipbin",
"billing_account_id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
"metadata": {
"rtp_debug": true
},
"email_verified": true,
"status": "active",
"identity_verification_status": "none",
"tm_deletion_scheduled": "2026-01-15T09:30:00.000000Z",
"tm_create": "2026-01-15T09:30:00.000000Z",
"tm_update": "2026-01-15T09:30:00.000000Z",
"tm_delete": "2026-01-15T09:30:00.000000Z"
},
"accesskey": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
"name": "Production API Key",
"detail": "API key for production environment",
"token": "vb_a3Bf9xKmPq2nR7sT4wYzLp8mN5qR1xWe",
"token_prefix": "vb_a3Bf9xKm",
"tm_expire": "2027-01-15T09:30:00.000000Z",
"tm_create": "2026-01-15T09:30:00.000000Z",
"tm_update": "2026-01-15T09:30:00.000000Z",
"tm_delete": "2026-01-15T09:30:00.000000Z"
}
}