Fetch specific Regulation Instance.

GET /v2/RegulatoryCompliance/Regulations/{Sid}
Account sid auth token

Fetch specific Regulation Instance.

Path parameters

  • Sid string Required

    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}$.

Query parameters

  • IncludeConstraints boolean

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

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 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.
GET /v2/RegulatoryCompliance/Regulations/{Sid} 
curl \
 --request GET 'https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/{Sid}' \
 --user "username:password"
Response examples (200) 
{
  "sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "iso_country": "AU",
  "number_type": "local",
  "requirements": {
    "end_user": [
      {
        "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/Regulations/individual",
        "name": "Individual",
        "type": "individual",
        "fields": [
          "first_name",
          "last_name"
        ],
        "detailed_fields": [
          {
            "description": "First name of the Individual",
            "machine_name": "first_name",
            "friendly_name": "First Name"
          },
          {
            "description": "Last name of the Individual",
            "machine_name": "last_name",
            "friendly_name": "Last Name"
          }
        ],
        "requirement_name": "individual_info"
      }
    ],
    "supporting_document": [
      [
        {
          "name": "Address",
          "type": "document",
          "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.",
          "requirement_name": "proof_of_address",
          "accepted_documents": [
            {
              "url": "https://numbers.twilio.com/v2/RegulatoryCompliance/DocumentTypes/address",
              "name": "Address Validation",
              "type": "address",
              "fields": [
                "address_sids"
              ],
              "detailed_fields": [
                {
                  "description": "Address sid of the individual",
                  "machine_name": "address_sids",
                  "friendly_name": "Address sid(s)"
                }
              ]
            }
          ]
        }
      ]
    ]
  },
  "end_user_type": "individual",
  "friendly_name": "Australia: Local - Individual"
}