Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Verification Check

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

Prerequisites:

  1. Create a Verification Service
  2. Start a Verification

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

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

status
string Not PII

The status of the verification. Can be: pending, approved, or denied.

valid
boolean Not PII

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

amount

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

payee

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.

Check a Verification

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

Twilio deletes the verification SID once it’s:

  • expired
  • 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 logs found in the Twilio Console under your Verification Service:

Verify Console 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
Required
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
        
        
        
        
        Example 2
              
              
              
              
              Alternative to checking with a Phone Number

              Check a Verification with a SID

              Alternative to checking with a Phone Number
              Rate this page:

              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 browsing the Twilio tag on Stack Overflow.