Skip to main content

Submit a verification code. Deprecation notice: `verify_profile_id' is now a mandatory field. The sunset date for this change is 2022-04-02 00:00:00.

POST 

/verifications/by_phone_number/:phone_number/actions/verify

Submit a verification code. Deprecation notice: `verify_profile_id' is now a mandatory field. The sunset date for this change is 2022-04-02 00:00:00.

Request

Path Parameters

    phone_number stringrequired

    The phone number associated with the verification code being verified.

Body

required

    code stringrequired

    This is the code the user submits for verification.

    verify_profile_id uuidrequired

    The identifier of the associated Verify profile.

Responses

200: Expected verify response to a valid request.

Schema

    data

    object

    required

    phone_number stringrequired

    +E164 formatted phone number.

    response_code stringrequired

    Possible values: [accepted, rejected]

    Identifies if the verification code has been accepted or rejected.

400: Bad Request

Schema

    errors

    Error[]

  • Array [

  • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta

    object

    url string

    URL with additional information on the error.

  • ]

Loading...