Fetch specific Verification Service Instance

GET /v2/Services/{Sid}

TODO: Resource-level docs

Fetch specific Verification Service Instance.

Path parameters

  • Sid string Required

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

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

    • code_length integer | null

      The length of the verification code

    • custom_code_enabled boolean | null

      Whether to allow sending verifications with a custom code.

    • 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

    • default_template_sid string | null

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

    • do_not_share_warning_enabled boolean | null

      Whether to add a security warning at the end of an SMS.

    • dtmf_input_required boolean | null

      Whether to ask the user to press a number before delivering the verify code in a phone call

    • friendly_name string | null

      The string that you assigned to describe the verification service

    • links object(uri-map) | null

      The URLs of related resources

    • lookup_enabled boolean | null

      Whether to perform a lookup with each verification

    • psd2_enabled boolean | null

      Whether to pass PSD2 transaction parameters when starting a verification

    • push

      The service level configuration of factor push type.

    • sid string | null

      The unique string that identifies the resource

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

    • skip_sms_to_landlines boolean | null

      Whether to skip sending SMS verifications to landlines

    • totp

      The service level configuration of factor TOTP type.

    • tts_name string | null

      The name of an alternative text-to-speech service to use in phone calls

    • url string(uri) | null

      The absolute URL of the resource
GET /v2/Services/{Sid} 
curl \
 -X GET https://verify.twilio.com/v2/Services/{Sid} \
 --user "username:password"
Response examples (200) 
{
  "account_sid": "string",
  "code_length": 42,
  "custom_code_enabled": true,
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "default_template_sid": "string",
  "do_not_share_warning_enabled": true,
  "dtmf_input_required": true,
  "friendly_name": "string",
  "links": {},
  "lookup_enabled": true,
  "psd2_enabled": true,
  "sid": "string",
  "skip_sms_to_landlines": true,
  "tts_name": "string",
  "url": "https://example.com"
}