Validate verification code

Validates the verification code for a verified caller ID.

Permissions

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

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.

Request

This endpoint expects an object.

verification_codestringRequired

The verification code received via call or SMS.

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.

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

404

Not Found 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)