Skip to main content
POST
/
phone-numbers
/
verified-caller-ids
Start caller ID verification
curl --request POST \
  --url https://api.helloannie.com/v1/phone-numbers/verified-caller-ids \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "<string>",
  "friendlyName": "<string>"
}
'
{
  "success": true,
  "data": {
    "verifiedCallerId": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "phoneNumber": "<string>",
      "friendlyName": "<string>",
      "status": "PENDING",
      "verificationStartedAt": "2023-11-07T05:31:56Z",
      "verifiedAt": "2023-11-07T05:31:56Z"
    },
    "validationCode": "<string>"
  },
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.helloannie.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

Payload to start phone number verification via Twilio

phoneNumber
string
required

Phone number to verify in E.164 format (+1XXXXXXXXXX)

friendlyName
string
required

Friendly name displayed by carriers when using this caller ID. Maximum 64 characters.

Required string length: 1 - 64

Response

Response after starting verification. Includes validation code to enter during the Twilio call.

success
enum<boolean>
required
Available options:
true
data
object
required
message
string
required