Skip to navigation
Phone NumbersVerified Caller ID

Get verified caller ID

View as MarkdownOpen in Claude

Retrieves one external caller-ID verification record from your SignalWire project. Use it to check or display an existing verification; use Get phone number for a project-owned number instead.

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)

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the verified caller ID.

Response

The request has succeeded.
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

500
Internal Server Error