GET /v2/RegulatoryCompliance/Regulations
Account sid auth token

Retrieve a list of all Regulations.

Query parameters

  • EndUserType string

    The type of End User the regulation requires - can be individual or business.

    Values are individual or business.

  • IsoCountry string

    The ISO country code of the phone number's country.

  • NumberType string

    The type of phone number that the regulatory requiremnt is restricting.

  • IncludeConstraints boolean

    A boolean parameter indicating whether to include constraints or not for supporting end user, documents and their fields

  • 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 that identifies the Regulation resource.

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

      • friendly_name string | null

        A human-readable description that is assigned to describe the Regulation resource. Examples can include Germany: Mobile - Business.

      • iso_country string | null

        The ISO country code of the phone number's country.

      • number_type string | null

        The type of phone number restricted by the regulatory requirement. For example, Germany mobile phone numbers provisioned by businesses require a business name with commercial register proof from the Handelsregisterauszug and a proof of address from Handelsregisterauszug or a trade license by Gewerbeanmeldung.

      • end_user_type string

        The type of End User the regulation requires - can be individual or business.

        Values are individual or business.

      • requirements object | null

        The SID of an object that holds the regulatory information of the phone number country, phone number type, and end user type.

      • url string(uri) | null

        The absolute URL of the Regulation 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 /v2/RegulatoryCompliance/Regulations 
curl \
 --request GET 'https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations' \
 --user "username:password"
Response examples (200) 
{
  "results": [],
  "meta": {
    "page": 0,
    "page_size": 50,
    "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?IsoCountry=US&IncludeConstraints=true&EndUserType=business&NumberType=mobile&PageSize=50&Page=0",
    "previous_page_url": null,
    "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?IsoCountry=US&IncludeConstraints=true&EndUserType=business&NumberType=mobile&PageSize=50&Page=0",
    "next_page_url": null,
    "key": "results"
  }
}
{
  "results": [
    {
      "sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "friendly_name": "Australia: Local - Individual",
      "iso_country": "AU",
      "number_type": "local",
      "end_user_type": "individual",
      "requirements": {
        "end_user": [
          {
            "name": "Individual",
            "type": "individual",
            "requirement_name": "individual_info",
            "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/individual",
            "fields": [
              "first_name",
              "last_name"
            ],
            "detailed_fields": [
              {
                "machine_name": "first_name",
                "friendly_name": "First Name",
                "description": "First name of the Individual"
              },
              {
                "machine_name": "last_name",
                "friendly_name": "Last Name",
                "description": "Last name of the Individual"
              }
            ]
          }
        ],
        "supporting_document": [
          [
            {
              "name": "Address",
              "type": "document",
              "requirement_name": "proof_of_address",
              "description": "The physical location of the individual or business. Must be within locality or region covered by the phone numbers prefix; a PO Box is not acceptable where a local address is required.",
              "accepted_documents": [
                {
                  "name": "Address Validation",
                  "type": "address",
                  "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/DocumentTypes/address",
                  "fields": [
                    "address_sids"
                  ],
                  "detailed_fields": [
                    {
                      "machine_name": "address_sids",
                      "friendly_name": "Address sid(s)",
                      "description": "Address sid of the individual"
                    }
                  ]
                }
              ]
            }
          ]
        ]
      },
      "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ],
  "meta": {
    "page": 0,
    "page_size": 50,
    "first_page_url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?PageSize=50&Page=0",
    "previous_page_url": null,
    "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations?PageSize=50&Page=0",
    "next_page_url": null,
    "key": "results"
  }
}