Retrieve a list of all Supporting Document Types.

GET /v1/SupportingDocumentTypes
Account sid auth token

Retrieve a list of all Supporting Document Types.

Query parameters

  • PageSize integer(int64)

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

  • Page integer

    The page index. This value is simply for client state.

    Minimum value is 0.

  • PageToken string

    The page token. This is provided by the API.

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
    • supporting_document_types array[object]
      Hide supporting_document_types attributes Show supporting_document_types 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.

    • meta object
      Hide meta attributes Show meta attributes object
      • first_page_url string(uri)
      • key string
      • next_page_url string(uri) | null
      • page integer
      • page_size integer
      • previous_page_url string(uri) | null
      • url string(uri)
GET /v1/SupportingDocumentTypes 
curl \
 --request GET 'https://trusthub.twilio.com/v1/SupportingDocumentTypes' \
 --user "username:password"
Response examples (200) 
{
  "supporting_document_types": [],
  "meta": {
    "page": 0,
    "page_size": 50,
    "first_page_url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0",
    "previous_page_url": null,
    "url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0",
    "next_page_url": null,
    "key": "supporting_document_types"
  }
}
{
  "supporting_document_types": [
    {
      "url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "fields": [
        {
          "machine_name": "address_sids",
          "friendly_name": "Address Sids",
          "constraint": "List"
        }
      ],
      "machine_name": "customer_profile_address",
      "friendly_name": "Customer profile address",
      "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    },
    {
      "url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes/OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "fields": [
        {
          "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",
          "constraint": "String"
        }
      ],
      "machine_name": "government_issued_proof_of_authorized_representative",
      "friendly_name": "Government Issued Identity certifying proof of being an authorized representative of a company",
      "sid": "OYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ],
  "meta": {
    "page": 0,
    "page_size": 50,
    "first_page_url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0",
    "previous_page_url": null,
    "url": "https://trusthub.twilio.com/v1/SupportingDocumentTypes?PageSize=50&Page=0",
    "next_page_url": null,
    "key": "supporting_document_types"
  }
}