Retrieve regulatory requirements

GET 
/regulatory_requirements

Retrieve regulatory requirements

Query Parameters

filter[phone_number] string

Phone number to check requirements for

filter[requirement_group_id] string

ID of requirement group to check requirements for

filter[country_code] string

Country code(iso2) to check requirements for

filter[phone_number_type] string

Possible values: [local, toll_free, mobile, national, shared_cost]

Phone number type to check requirements for

filter[action] string

Possible values: [ordering, porting, action]

Action to check requirements for

200: An array of Regulatory Requirements Responses

application/json

• Schema
• Example (from schema)

Schema

data

RegulatoryRequirements[]

Array [

country_code string

phone_number_type string

action string

regulatory_requirements

object[]

Array [

description string

id uuid

example string

name string

field_type string

acceptance_criteria

object

locality_limit string

time_limit string

regex string

case_sensitive string

acceptable_characters string

acceptable_values string[]

max_length string

min_length string

]

]

{
  "data": [
    {
      "country_code": "DE",
      "phone_number_type": "local",
      "action": "ordering",
      "regulatory_requirements": [
        {
          "description": "Address matching the DID area code (street, building number, postal code, city and country)",
          "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
          "example": "311 W Superior St, Chicago, IL 60654",
          "name": "Address matching the DID area code",
          "field_type": "address_id",
          "acceptance_criteria": {
            "locality_limit": "Identical locality as the numbers desired",
            "time_limit": "Less than 5 months old",
            "regex": "regex field value must match",
            "case_sensitive": "Whether field value is case sensitive",
            "acceptable_characters": "Characters that can be included in field value",
            "acceptable_values": [
              "string"
            ],
            "max_length": "10",
            "min_length": "5"
          }
        }
      ]
    }
  ]
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta

object

url string

URL with additional information on the error.

]

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/regulatory_requirements' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "data": [
    {
      "country_code": "DE",
      "phone_number_type": "local",
      "action": "ordering",
      "regulatory_requirements": [
        {
          "description": "Address matching the DID area code (street, building number, postal code, city and country)",
          "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
          "example": "311 W Superior St, Chicago, IL 60654",
          "name": "Address matching the DID area code",
          "field_type": "address_id",
          "acceptance_criteria": {
            "locality_limit": "Identical locality as the numbers desired",
            "time_limit": "Less than 5 months old",
            "regex": "regex field value must match",
            "case_sensitive": "Whether field value is case sensitive",
            "acceptable_characters": "Characters that can be included in field value",
            "acceptable_values": [
              "string"
            ],
            "max_length": "10",
            "min_length": "5"
          }
        }
      ]
    }
  ]
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}