challenge a specific Verification Check.

POST /v2/Services/{ServiceSid}/VerificationCheck

Account sid auth token

Path parameters

ServiceSid string Required

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

Minimum length is 34, maximum length is 34. Format should match the following pattern: ^VA[0-9a-fA-F]{32}$.

application/x-www-form-urlencoded

Body

Code string

The 4-10 character string being verified.
To string

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

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

Minimum length is 34, maximum length is 34. Format should match the following pattern: ^VE[0-9a-fA-F]{32}$.
Amount string

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

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

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.

Responses

200 application/json

OK
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
  
  Specify the origin(s) allowed to access the resource
- Access-Control-Allow-Methods string
  
  Specify the HTTP methods allowed when accessing the resource
- Access-Control-Allow-Headers string
  
  Specify the headers allowed when accessing the resource
- Access-Control-Allow-Credentials boolean
  
  Indicates whether the browser should include credentials
- Access-Control-Expose-Headers string
  
  Headers exposed to the client
Hide response attributes Show response attributes object
- sid string | null
  
  The unique string that we created to identify the VerificationCheck resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^VE[0-9a-fA-F]{32}$.
- service_sid string | null
  
  The SID of the Service the resource is associated with.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^VA[0-9a-fA-F]{32}$.
- account_sid string | null
  
  The SID of the Account that created the VerificationCheck resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- to string | null
  
  The phone number or email being verified. Phone numbers must be in E.164 format.
- channel string
  
  The verification method to use. One of: email, sms, whatsapp, call, or sna.
  
  Values are sms, call, email, whatsapp, or sna.
- status string | null
  
  The status of the verification. Can be: pending, approved, canceled, max_attempts_reached, deleted, failed or expired.
- valid boolean | null
  
  Use "status" instead. Legacy property indicating whether the verification was successful.
- amount string | null
  
  The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
- payee string | null
  
  The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
- date_created string(date-time) | null
  
  The ISO 8601 date and time in GMT when the Verification Check resource was created.
- date_updated string(date-time) | null
  
  The ISO 8601 date and time in GMT when the Verification Check resource was last updated.
- sna_attempts_error_codes array | null
  
  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.
201 application/json

Created
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
  
  Specify the origin(s) allowed to access the resource
- Access-Control-Allow-Methods string
  
  Specify the HTTP methods allowed when accessing the resource
- Access-Control-Allow-Headers string
  
  Specify the headers allowed when accessing the resource
- Access-Control-Allow-Credentials boolean
  
  Indicates whether the browser should include credentials
- Access-Control-Expose-Headers string
  
  Headers exposed to the client
Hide response attributes Show response attributes object
- sid string | null
  
  The unique string that we created to identify the VerificationCheck resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^VE[0-9a-fA-F]{32}$.
- service_sid string | null
  
  The SID of the Service the resource is associated with.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^VA[0-9a-fA-F]{32}$.
- account_sid string | null
  
  The SID of the Account that created the VerificationCheck resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- to string | null
  
  The phone number or email being verified. Phone numbers must be in E.164 format.
- channel string
  
  The verification method to use. One of: email, sms, whatsapp, call, or sna.
  
  Values are sms, call, email, whatsapp, or sna.
- status string | null
  
  The status of the verification. Can be: pending, approved, canceled, max_attempts_reached, deleted, failed or expired.
- valid boolean | null
  
  Use "status" instead. Legacy property indicating whether the verification was successful.
- amount string | null
  
  The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
- payee string | null
  
  The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
- date_created string(date-time) | null
  
  The ISO 8601 date and time in GMT when the Verification Check resource was created.
- date_updated string(date-time) | null
  
  The ISO 8601 date and time in GMT when the Verification Check resource was last updated.
- sna_attempts_error_codes array | null
  
  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.

POST /v2/Services/{ServiceSid}/VerificationCheck

curl \
 --request POST 'https://verify.twilio.com/v2/Services/{ServiceSid}/VerificationCheck' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'To=%2B15017122661&Code=1234&Payee=Acme+Inc.&Amount=%E2%82%AC39.99&VerificationSid=VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'

Request examples

{"To"=>"+15017122661", "Code"=>"1234", "Payee"=>"Acme Inc.", "Amount"=>"€39.99", "VerificationSid"=>"VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}

{"To"=>"recipient@foo.com", "Code"=>"123456", "VerificationSid"=>"VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}

{"To"=>"+15017122661", "Code"=>"1234", "Payee"=>"Acme Inc.", "Amount"=>"€39.99", "VerificationSid"=>"VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}

{"To"=>"+15017122661"}

Response examples (200)

{
  "to": "+15017122661",
  "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "payee": null,
  "valid": true,
  "amount": null,
  "status": "approved",
  "channel": "sms",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2015-07-30T20:00:00Z",
  "date_updated": "2015-07-30T20:00:00Z",
  "sna_attempts_error_codes": []
}

Response examples (201)

{
  "to": "+15017122661",
  "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "payee": null,
  "valid": true,
  "amount": null,
  "status": "approved",
  "channel": "sms",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2015-07-30T20:00:00Z",
  "date_updated": "2015-07-30T20:00:00Z",
  "sna_attempts_error_codes": []
}

{
  "to": "recipient@foo.com",
  "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "payee": null,
  "valid": true,
  "amount": null,
  "status": "approved",
  "channel": "email",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2020-01-30T20:00:00Z",
  "date_updated": "2020-01-30T20:00:00Z",
  "sna_attempts_error_codes": []
}

{
  "to": "+15017122661",
  "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "payee": null,
  "valid": true,
  "amount": null,
  "status": "approved",
  "channel": "sna",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2015-07-30T20:00:00Z",
  "date_updated": "2015-07-30T20:00:00Z",
  "sna_attempts_error_codes": [
    {
      "code": 60001,
      "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ]
}