Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
Auth

Cancel account deletion (self-service recover).

Cancels a scheduled deletion and restores the authenticated customer's account to active state. Only works during the 30-day grace period while the account is in 'frozen' status. No request body required.

delete/auth/unregister

Query parameters

accesskeystring

API access key token. Returned from the GET /accesskeys response. Alternative to Bearer token authentication.

Response

Account recovered successfully.

idstring uuid

The unique identifier of the customer.

namestring

Name of the customer.

detailstring

Details about the customer.

emailstring email

Email address of the customer.

phone_numberstring

Customer's contact phone number in E.164 format.

addressstring

Address of the customer.

webhook_method'' | 'POST' | 'GET' | 'PUT' | 'DELETE'

The HTTP method used for webhook (e.g., POST, GET, PUT, DELETE).

webhook_uristring

URI where webhook events are delivered.

billing_account_idstring uuid

The unique identifier of the customer's default billing account. Returned from the GET /billing_accounts/{id} response.

email_verifiedboolean

Whether the customer's email has been verified.

status'active' | 'frozen' | 'deleted'

Account lifecycle status.

identity_verification_status'none' | 'pending' | 'verified' | 'rejected'

Customer's identity verification status. Determines access to PSTN number purchases and outbound PSTN calls.

tm_deletion_scheduledstring date-time

Timestamp when account deletion was requested. Null if not scheduled.

tm_createstring date-time

Timestamp when the customer was created.

tm_updatestring date-time

Timestamp when the customer was last updated.

tm_deletestring date-time

Timestamp when the customer was deleted.

Example response

{
  "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"
}