Update a Verification status

POST /v2/Services/{ServiceSid}/Verifications/{Sid}

TODO: Resource-level docs

Update a Verification status

Path parameters

  • ServiceSid string Required

    The SID of the verification Service to update the resource from.

  • Sid string Required

    The Twilio-provided string that uniquely identifies the Verification resource to update.

Body

  • Status string Required

    The new status of the resource. Can be: canceled or approved.

    Values are canceled or approved.

Responses

  • 200

    OK

    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 used.

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

    • date_created string(date-time) | null

      The RFC 2822 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The RFC 2822 date and time in GMT when the resource was last updated

    • lookup

      Information about the phone number being verified

    • payee string | null

      The payee of the associated PSD2 compliant transaction

    • send_code_attempts array | null

      An array of verification attempt objects.

    • 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

    • url string(uri) | null

      The absolute URL of the Verification resource

    • valid boolean | null

      Whether the verification was successful
POST /v2/Services/{ServiceSid}/Verifications/{Sid} 
curl \
 -X POST https://verify.twilio.com/v2/Services/{ServiceSid}/Verifications/{Sid} \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Status=canceled'
Request example 
{
  "Status": "canceled"
}
Request examples 
{
  "Status": "canceled"
}
Response examples (200) 
{
  "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",
  "send_code_attempts": [],
  "service_sid": "string",
  "sid": "string",
  "status": "string",
  "to": "string",
  "url": "https://example.com",
  "valid": true
}
Response examples (200) 
{
  "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",
  "send_code_attempts": [],
  "service_sid": "string",
  "sid": "string",
  "status": "string",
  "to": "string",
  "url": "https://example.com",
  "valid": true
}