Skip to main content

Trigger a Whatsapp verification

POST 

/verifications/whatsapp

Trigger a Whatsapp verification

Request

Body

required

    phone_number stringrequired

    +E164 formatted phone number.

    verify_profile_id uuidrequired

    The identifier of the associated Verify profile.

    timeout_secs integer

    The number of seconds the verification code is valid for.

Responses

200: Expected verifications response to a valid request.

Schema

    data

    object

    required

    id uuid
    type VerificationType

    Possible values: [sms, psd2, whatsapp, call, flashcall]

    The possible types of verification.

    record_type VerificationRecordType

    Possible values: [verification]

    The possible verification record types.

    phone_number string

    +E164 formatted phone number.

    verify_profile_id uuid

    The identifier of the associated Verify profile.

    timeout_secs integer

    This is the number of seconds before the code of the request is expired. Once this request has expired, the code will no longer verify the user. Note: this will override the default_verification_timeout_secs on the Verify profile.

    call_timeout_secs integer

    This is the number of seconds before the call ends, if the verification makes a call. Note: this will override the default_call_timeout_secs on the Verify profile.

    status VerificationStatus

    Possible values: [pending, accepted, invalid, expired, error]

    The possible statuses of the verification request.

    created_at string
    updated_at string

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...