Update a Verification status

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

Update a Verification status

Path parameters

  • ServiceSid string Required

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

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

  • Sid string Required

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

application/x-www-form-urlencoded

Body

  • Status string Required

    The status of the verification. Can be: pending, approved, canceled, max_attempts_reached, deleted, failed or expired.

    Values are canceled or approved.

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 Verification 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 Verification 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 used. One of: email, sms, whatsapp, call, sna, or rcs.

      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.

    • lookup

      Information about the phone number being verified.

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

    • send_code_attempts array | null

      An array of verification attempt objects containing the channel attempted and the channel-specific transaction SID.

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • sna

      The set of fields used for a silent network auth (sna) verification. Contains a single field with the URL to be invoked to verify the phone number.

    • url string(uri) | null

      The absolute URL of the Verification resource.

POST /v2/Services/{ServiceSid}/Verifications/{Sid}
curl \
 --request POST 'https://verify.twilio.com/v2/Services/{ServiceSid}/Verifications/{Sid}' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Status=canceled'
Request examples
{"Status"=>"canceled"}
{"Status"=>"approved"}
Response examples (200)
{
  "to": "+15017122661",
  "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "sna": null,
  "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "payee": null,
  "valid": false,
  "amount": null,
  "lookup": {},
  "status": "canceled",
  "channel": "sms",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2015-07-30T20:00:00Z",
  "date_updated": "2015-07-30T20:00:00Z",
  "send_code_attempts": [
    {
      "time": "2015-07-30T20:00:00Z",
      "channel": "SMS",
      "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ]
}
{
  "to": "+15017122661",
  "sid": "VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "sna": null,
  "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Verifications/VEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "payee": null,
  "valid": true,
  "amount": null,
  "lookup": {},
  "status": "approved",
  "channel": "sms",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2015-07-30T20:00:00Z",
  "date_updated": "2015-07-30T20:00:00Z",
  "send_code_attempts": [
    {
      "time": "2015-07-30T20:00:00Z",
      "channel": "SMS",
      "attempt_sid": "VLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ]
}