Challenge a specific Verification Check

POST /v2/Services/{ServiceSid}/VerificationCheck

TODO: Resource-level docs

challenge a specific Verification Check.

Path parameters

Body

  • Amount string

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

  • Code string Required

    The 4-10 character string being verified.

  • Payee string

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

  • 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}$.

Responses

  • 201

    Created

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

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

    • amount string | null

      The amount of the associated PSD2 compliant transaction.

    • channel string | null

      The verification method to use

      Values are sms, call, email, whatsapp, or silent.

    • 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

    • payee string | null

      The payee of the associated PSD2 compliant transaction

    • service_sid string | null

      The SID of the Service that 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}$.

    • sid string | null

      The unique string that identifies the resource

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

    • status string | null

      The status of the verification resource

    • to string | null

      The phone number or email being verified

    • valid boolean | null

      Whether the verification was successful
POST /v2/Services/{ServiceSid}/VerificationCheck 
curl \
 -X POST https://verify.twilio.com/v2/Services/{ServiceSid}/VerificationCheck \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Amount=string&Code=string&Payee=string&To=string&VerificationSid=string'
Request example 
{
  "Amount": "string",
  "Code": "string",
  "Payee": "string",
  "To": "string",
  "VerificationSid": "string"
}
Request examples 
{
  "Amount": "string",
  "Code": "string",
  "Payee": "string",
  "To": "string",
  "VerificationSid": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "amount": "string",
  "channel": "sms",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "payee": "string",
  "service_sid": "string",
  "sid": "string",
  "status": "string",
  "to": "string",
  "valid": true
}
Response examples (201) 
{
  "account_sid": "string",
  "amount": "string",
  "channel": "sms",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "payee": "string",
  "service_sid": "string",
  "sid": "string",
  "status": "string",
  "to": "string",
  "valid": true
}