Skip to navigation
Phone NumbersVerified Caller ID

Create verified caller ID

View as MarkdownOpen in Claude

Starts verification of an external phone number for use as an outbound caller ID. Use it when presenting a number the project does not own; use a purchased or imported project number directly instead.

Creating the record immediately places a voice call to number that reads out a 6-digit verification code, so have the phone ready before you send the request. Complete the flow by submitting that code with Validate verification code. Verification calls to the same number are limited to one per minute; requesting another call sooner, through this operation or Redial verification call, returns 422.

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.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

Request

This endpoint expects an object.
numberstringRequired

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.

namestringOptional<=200 characters
The name portion of the caller ID. If not provided, the default will be the formatted number.
extensionstringOptional
The extension of the phone number for the caller ID. This is only used when placing the verification call.

Response

The request has succeeded and a new resource has been created as a result.
idstringformat: "uuid"
The unique identifier of the Verified Caller ID on SignalWire.
numberstring
String representing the phone number for the caller ID. This must be a valid, routeable phone number in E.164 format.
extensionstring or null

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

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

The date and time that the number was verified, or null if the number has not been verified.

typestringOptional

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

namestringOptional
String representing the name portion of the caller ID. If not provided, the default will be the formatted number that has been provided.
statusenumOptional
The verification status for the caller ID.
Allowed values:

Errors

422
Unprocessable Entity Error
500
Internal Server Error