Skip to main content

Validate the Verification Code

Supplies the verification code that was read during the verification call.

RESTRICTIONS

  • There is a limit of 5 attempts to enter a validation code for a number. Once exhausted, you may request a redial of the verification call to reset the code and try again.
Path Parameters
id uuid REQUIRED

Unique unique identifier of the Verified Caller ID on SignalWire

Request Body REQUIRED
verification_code string

String representing the verification code that was read during the verification call.

Responses
200

OK

Schema
type string

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

id uuid

The unique identifier of the Verified Caller ID on SignalWire.

verified boolean

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

verified_at string

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

status string

String representing the verification status for the caller ID. Current values are "Verified" and "Awaiting Verification"

name string

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

extension string

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

number string

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.