SUsurgeapi
Verifications

Create a verification

Changed on

Creates a new Verification for an account and sends the code to the given phone number.

post/accounts/{account_id}/verifications

Request

  • Base URL
    https://api.surge.app
  • URL
    https://api.surge.app/accounts/{account_id}/verifications
  • Auth
    HTTP bearer

Path parameters

account_idstring required

The account to associate with the verification.

Example:acct_01j9a43avnfqzbjfch6pygv1td

Request body

phone_numberstring phone-number required

The phone number to be verified. In E.164 format.

Example request

{
  "phone_number": "+18015551234"
}

Response

Created verification

attempt_countinteger required

The number of times the code has been attempted.

idstring required

Unique identifier for the object.

phone_numberstring phone-number required

The phone number being verified. In E.164 format.

status'pending' | 'verified' | 'exhausted' | 'expired' required

The current status of the verification.

Example response

{
  "attempt_count": 0,
  "id": "vfn_01jayh15c2f2xamftg0xpyq1nj",
  "phone_number": "+18015551234",
  "status": "pending"
}

Changes