Skip to main content

Validate the Verification Code

PUT 
/verified_caller_ids/:id/verification

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.

Request​

Path Parameters

    id uuidrequired

    Unique unique identifier of the Verified Caller ID on SignalWire

Body

required

    verification_code stringrequired

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

    Example: 123456

Responses​

OK

Schema

    type string

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

    Example: verified_caller_id
    id uuid

    The unique identifier of the Verified Caller ID on SignalWire.

    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.

    Example: C-3P0
    extension string

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

    Example: 1234
    number stringrequired

    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.

    Example: +15551234567
    verified boolean

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

    Example: false
    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.

    Example: null
    status string

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

    Example: Awaiting Verification