Retrieve a list of all Supporting Document for an account.

GET /v1/SupportingDocuments

Retrieve a list of all Supporting Document for an account.

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
    • results array[object]
      Hide results attributes Show results attributes object
      • sid string | null

        The unique string created by Twilio to identify the Supporting Document resource.

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

      • account_sid string | null

        The SID of the Account that created the Document resource.

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

      • friendly_name string | null

        The string that you assigned to describe the resource.

      • mime_type string | null

        The image type uploaded in the Supporting Document container.

      • status string

        The verification status of the Supporting Document resource.

        Values are DRAFT, PENDING_REVIEW, REJECTED, APPROVED, EXPIRED, or PROVISIONALLY_APPROVED.

      • type string | null

        The type of the Supporting Document.

      • attributes

        The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types.

      • date_created string(date-time) | null

        The date and time in GMT when the resource was created specified in ISO 8601 format.

      • date_updated string(date-time) | null

        The date and time in GMT when the resource was last updated specified in ISO 8601 format.

      • url string(uri) | null

        The absolute URL of the Supporting Document 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/SupportingDocuments
curl \
 --request GET 'https://trusthub.twilio.com/v1/SupportingDocuments' \
 --user "username:password"
Response examples (200)
{
  "meta": {
    "key": "results",
    "url": "https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "results": []
}
{
  "meta": {
    "key": "results",
    "url": "https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://trusthub.twilio.com/v1/SupportingDocuments?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "results": [
    {
      "sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "url": "https://trusthub.twilio.com/v1/SupportingDocuments/RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "type": "customer_profile_address",
      "status": "DRAFT",
      "mime_type": null,
      "attributes": {
        "address_sids": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
      },
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "date_created": "2021-02-11T17:23:00Z",
      "date_updated": "2021-02-11T17:23:00Z",
      "friendly_name": "Business-profile-physical-address"
    }
  ]
}