Synchronous operation to retrieve configurations for the customer.

GET /v1/SigningRequest/Configuration

Synchronous operation to retrieve configurations for the customer.

Query parameters

  • Country string

    The country ISO code to apply this configuration, this is an optional field, Example: US, MX

  • Product string

    The product or service for which is requesting the signature, this is an optional field, Example: Porting, Hosting

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

        The SID of the document that includes the logo that will appear in the LOA. To upload documents follow the following guide: https://www.twilio.com/docs/phone-numbers/regulatory/getting-started/create-new-bundle-public-rest-apis#supporting-document-create

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

      • friendly_name string | null

        This is the string that you assigned as a friendly name for describing the creation of the configuration.

      • product string | null

        The product or service for which is requesting the signature.

      • country string(iso-country-code) | null

        The country ISO code to apply the configuration.

      • email_subject string | null

        Subject of the email that the end client will receive ex: “Twilio Hosting Request”, maximum length of 255 characters.

      • email_message string | null

        Content of the email that the end client will receive ex: “This is a Hosting request from Twilio, please check the document and sign it”, maximum length of 5,000 characters.

      • url_redirection string | null

        Url the end client will be redirected after signing a document.

      • url string(uri) | null
    • 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/SigningRequest/Configuration
curl \
 --request GET 'https://numbers.twilio.com/v1/SigningRequest/Configuration' \
 --user "username:password"
Response examples (200)
{
  "meta": {
    "key": "configurations",
    "url": "https://numbers.twilio.com/v1/SigningRequest/Configuration?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://numbers.twilio.com/v1/SigningRequest/Configuration?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "configurations": [
    {
      "url": "https://numbers.twilio.com/v1/SigningRequest/Configuration",
      "country": "CL",
      "product": "Hosting",
      "logo_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "email_message": "Email Message",
      "email_subject": "Email Subject",
      "friendly_name": "Hosting CL",
      "url_redirection": "https://www.twilio.com/redirect-url"
    }
  ]
}
{
  "meta": {
    "key": "configurations",
    "url": "https://numbers.twilio.com/v1/SigningRequest/Configuration?Product=Porting&Country=MX&PageSize=50&Page=0&PageToken=PTtestPageToken",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://numbers.twilio.com/v1/SigningRequest/Configuration?Product=Porting&Country=MX&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "configurations": [
    {
      "url": "https://numbers.twilio.com/v1/SigningRequest/Configuration",
      "country": "MX",
      "product": "Porting",
      "logo_sid": "RDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "email_message": "Email Message",
      "email_subject": "Email Subject",
      "friendly_name": "friendly name",
      "url_redirection": "https://my-redirection-url.com/redirect"
    }
  ]
}