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.

Permissions

The API token must include the following scopes: Voice.

Path Parameters
id uuid REQUIRED

Unique unique identifier of the Verified Caller ID on SignalWire

Request Body REQUIRED
verification_code string REQUIRED

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

Responses
200

OK

Schema OPTIONAL
type string OPTIONAL

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

id uuid OPTIONAL

The unique identifier of the Verified Caller ID on SignalWire.

verified boolean OPTIONAL

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

verified_at string OPTIONAL

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 OPTIONAL

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