For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
  • Datasphere
  • Logs
  • Messaging
  • Phone Number Management
      • POSTCreate verified caller ID
      • DELDelete verified caller ID
      • GETGet verified caller ID
      • GETList verified caller IDs
      • POSTRedial verification call
      • PUTUpdate verified caller ID
      • PUTValidate verification code
  • Platform
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
Phone Number ManagementVerified Caller ID

Create verified caller ID

|View as Markdown|Open in Claude|
POST
https://{your_space_name}.signalwire.com/api/relay/rest/verified_caller_ids
POST
/api/relay/rest/verified_caller_ids
$curl -X POST https://{your_space_name}.signalwire.com/api/relay/rest/verified_caller_ids \
>     -H "Content-Type: application/json" \
>     -u "<project_id>:<api_token>" \
>     -d '{
>  "number": "+15551234567"
>}'
1{
2  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3  "number": "+15551234567",
4  "verified": false,
5  "type": "verified_caller_id",
6  "name": "C-3P0",
7  "extension": "1234",
8  "verified_at": "2024-01-15T09:30:00Z",
9  "status": "Awaiting Verification"
10}
Creates a new verified caller ID. A verification code will be sent to the phone number. #### 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](/docs/platform/your-signalwire-api-space).
Was this page helpful?
Previous

Delete verified caller ID

Next
Built with

Creates a new verified caller ID. A verification code will be sent to the phone number.

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.
verifiedboolean
A boolean representing whether the number has been verified or not.
typestring

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

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.
verified_atdatetime
Nullable DateTime field representing the date and time that the number was verified. If the number has not been verified, it will be null.
statusenum
The verification status for the caller ID.
Allowed values:

Errors

401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error

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)