Sign in
Verified Caller ID

Create verified caller ID

Starts verification of an external phone number for use as an outbound caller ID and sends a verification code to that number. Use it when presenting a number the project does not own; use a purchased or imported project number directly instead. Complete the flow with Validate verification code.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

post/api/relay/rest/verified_caller_ids

Request body

numberstring required

String representing the phone number for the caller ID. This must be a valid, routeable phone number in E.164 format that is able to receive a voice phone call for verification.

namestring

The name portion of the caller ID. If not provided, the default will be the formatted number.

extensionstring

The extension of the phone number for the caller ID. This is only used when placing the verification call.

Example request

{
  "number": "+15551234567",
  "name": "C-3P0",
  "extension": "1234"
}

Response

The request has succeeded and a new resource has been created as a result.

typestring

The type of the returned object, this should be verified_caller_id.

idstring uuid required

Universal Unique Identifier.

numberstring required

String representing the phone number for the caller ID. This must be a valid, routeable phone number in E.164 format.

namestring

String representing the name portion of the caller ID. If not provided, the default will be the formatted number that has been provided.

extensionstring

String representing the extension of the phone number for the caller ID. This is only used when placing the verification call.

verifiedboolean required

A boolean representing whether the number has been verified or not.

verified_atstring date-time

Nullable DateTime field representing the date and time that the number was verified. If the number has not been verified, it will be null.

status'Verified' | 'Awaiting Verification'

The verification status for the caller ID.

Example response

{
  "type": "verified_caller_id",
  "number": "+15551234567",
  "name": "C-3P0",
  "extension": "1234",
  "status": "Awaiting Verification"
}

Changes

No changes found, but 3 of the 138 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.