Fetch a specific Supporting Document Type Instance.

GET /v1/SupportingDocumentTypes/{Sid}
Account sid auth token

Fetch a specific Supporting Document Type Instance.

Path parameters

  • Sid string Required

    The unique string that identifies the Supporting Document Type resource.

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 identifies the Supporting Document Type resource.

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

    • friendly_name string | null

      A human-readable description of the Supporting Document Type resource.

    • machine_name string | null

      The machine-readable description of the Supporting Document Type resource.

    • fields array | null

      The required information for creating a Supporting Document. The required fields will change as regulatory needs change and will differ for businesses and individuals.

    • url string(uri) | null

      The absolute URL of the Supporting Document Type resource.
GET /v1/SupportingDocumentTypes/{Sid} 
curl \
 --request GET 'https://trusthub.twilio.com/v1/SupportingDocumentTypes/{Sid}' \
 --user "username:password"
Response examples (200) 
{
  "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "fields": [
    {
      "constraint": "String",
      "machine_name": "first_name",
      "friendly_name": "First Name"
    },
    {
      "constraint": "String",
      "machine_name": "last_name",
      "friendly_name": "Last Name"
    },
    {
      "constraint": "String",
      "machine_name": "business_name",
      "friendly_name": "Business Name"
    }
  ],
  "machine_name": "government_issued_proof_of_authorized_representative",
  "friendly_name": "Government Issued Identity certifying proof of being an authorized representative of a company"
}