TWtwilio
VerifyV2VerificationCheck

challenge a specific Verification Check.

Changed on

challenge a specific Verification Check.

post/v2/Services/{ServiceSid}/VerificationCheck

Request

  • Base URL
    https://verify.twilio.com
  • URL
    https://verify.twilio.com/v2/Services/{ServiceSid}/VerificationCheck
  • Auth
    • HTTP basic
    • or HTTP bearer

Path parameters

ServiceSidstring required

The SID of the verification Service to create the resource under.

Request body application/x-www-form-urlencoded

Codestring

The 4-10 character string being verified.

Tostring

The phone number or email to verify. Either this parameter or the verification_sid must be specified. Phone numbers must be in E.164 format.

VerificationSidstring

A SID that uniquely identifies the Verification Check. Either this parameter or the to phone number/email must be specified.

Amountstring

The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.

Payeestring

The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.

SnaClientTokenstring

A sna client token received in sna url invocation response needs to be passed in Verification Check request and should match to get successful response.

Response

OK

sidstring nullable

The unique string that we created to identify the VerificationCheck resource.

service_sidstring nullable

The SID of the Service the resource is associated with.

account_sidstring nullable

The SID of the Account that created the VerificationCheck resource.

tostring nullable

The phone number or email being verified. Phone numbers must be in E.164 format.

channel'sms' | 'call' | 'email' | 'whatsapp' | 'sna'

The verification method to use. One of: email, sms, whatsapp, call, or sna.

statusstring nullable

The status of the verification. Can be: pending, approved, canceled, max_attempts_reached, deleted, failed or expired.

validboolean nullable

Use "status" instead. Legacy property indicating whether the verification was successful.

amountstring nullable

The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.

payeestring nullable

The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.

date_createdstring date-time nullable

The ISO 8601 date and time in GMT when the Verification Check resource was created.

date_updatedstring date-time nullable

The ISO 8601 date and time in GMT when the Verification Check resource was last updated.

Changes

  • v2d5d7b4a5714fRevision changes
    • info

      the endpoint scheme security access_token_bearer was added to the API

  • v21548692e6804Revision changes
    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status