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
|
The unique string that we created to identify the VerificationCheck resource. |
service_sid
|
The SID of the Service the resource is associated with. |
account_sid
|
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
|
The verification method to use. One of: |
status
|
The status of the verification. Can be: |
valid
|
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
|
The ISO 8601 date and time in GMT when the Verification Check resource was created. |
date_updated
|
The ISO 8601 date and time in GMT when the Verification Check resource was last updated. |
sna_attempts_error_codes
|
List of error codes as a result of attempting a verification using the |
Check a Verification
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
|
The SID of the verification Service to create the resource under. |
code
Optional
|
The 4-10 character string being verified. |
to
Optional
|
The phone number or email to verify. Either this parameter or the |
verification_sid
Optional
|
A SID that uniquely identifies the Verification Check. Either this parameter or the |
amount
Optional
|
The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. |
payee
Optional
|
The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled. |
Example 1
Example 2
Example 3
Example 4
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.