Verification Check

The Verification Check Resource represents a verification validation. This will check whether the user-provided token is correct.

Prerequisites:

VerificationCheck Response Properties

These fields are returned in the output JSON response. The type SID<VE> is a unique ID starting with the letters VE.

Resource Properties in REST API format
`sid`	sid<VE> Not PII The unique string that we created to identify the VerificationCheck resource.
`service_sid`	sid<VA> Not PII The SID of the Service the resource is associated with.
`account_sid`	sid<AC> Not PII The SID of the Account that created the VerificationCheck resource.
`to`	string PII MTL: 30 DAYS The phone number or email being verified. Phone numbers must be in E.164 format.
`channel`	enum:channel Not PII The verification method to use. One of: `email`, `sms`, `whatsapp`, `call`, or `sna`.
`status`	string Not PII The status of the verification. Can be: `pending`, `approved`, or `canceled`.
`valid`	boolean Not PII Use "status" instead. Legacy property indicating whether the verification was successful.
`amount`	string PII MTL: 1 DAYS The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
`payee`	string PII MTL: 1 DAYS The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
`date_created`	date_time<iso8601> Not PII The ISO 8601 date and time in GMT when the Verification Check resource was created.
`date_updated`	date_time<iso8601> Not PII The ISO 8601 date and time in GMT when the Verification Check resource was last updated.
`sna_attempts_error_codes`	object[] Not PII List of error codes as a result of attempting a verification using the `sna` channel. The error codes are chronologically ordered, from the first attempt to the latest attempt. This will be an empty list if no errors occured or `null` if the last channel used wasn't `sna`.

Check a Verification

post

https://verify.twilio.com/v2/Services/{ServiceSid}/VerificationCheck

Twilio deletes the verification SID once it’s:

expired (10 minutes)
approved
when the max attempts to check a code have been reached

If any of these occur, verification checks will return a 404 not found error like this:

Unable to create record: The requested resource /Services/VAXXXXXXXXXXXXX/VerificationCheck was not found

If you’d like to double check what happened with a given verification - please use the Twilio Console Verify Logs.

These are the available input parameters for checking a verification. The type SID<VE> is a unique ID starting with the letters VE.

Parameters

Parameters in REST API format
`service_sid` Path	post sid<VA> Not PII The SID of the verification Service to create the resource under.
`code` Optional	post string Not PII The 4-10 character string being verified.
`to` Optional	post string PII MTL: 30 DAYS 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.
`verification_sid` Optional	post sid<VE> Not PII A SID that uniquely identifies the Verification Check. Either this parameter or the `to` phone number/email must be specified.
`amount` Optional	post string PII MTL: 1 DAYS The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
`payee` Optional	post string PII MTL: 1 DAYS The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.

Example 1

Loading Code Sample...

Example JSON response

Check a Verification with a Phone Number

Example 2

Loading Code Sample...

Example JSON response

Check a Verification with an Email

Example 3

Loading Code Sample...

Example JSON response

Alternative to checking with a Phone Number

Check a Verification with a SID

Alternative to checking with a Phone Number

Example 4

Loading Code Sample...

Example JSON response

Note the sna_attempts_error_codes property in the response

Check a Silent Network Auth Verification with Error Codes

Note the sna_attempts_error_codes property in the response

It is possible for a Silent Network Auth (SNA) Verification Check to show a status of approved with error codes listed under sna_attempts_error_codes. This can happen when a Verification Attempt for the SNA Verification failed and resulted in an error, and then a subsequent Verification Attempt was successful and resulted in the approval.

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.