This is the API V2 documentation. To switch out of beta revert back to our API V1.

Open SidemenuAPI Reference
API Reference
Close Sidemenu

Number Order Regulatory Requirements

Get list of Number Order Regulatory RequirementslistNumberOrderRegulatoryRequirements

get https://api.telnyx.com/v2/regulatory_requirements

Gets a paginated list of Number Order Regulatory Requirements

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/regulatory_requirements?filter[requirement_id]=36aaf27d-986b-493c-bd1b-de16af2e4292"
Parameters
In query
filter[requirement_id]
string
optional

Filter number order regulatory requirements by requirement_id

filter[field_type]
string
optional

Filter number order regulatory requirements by field_type

filter[requirement_type]
string
optional

Filter number order regulatory requirements by requirement_type

Responses
200

Returns a list of number order regulatory requirements

default

Unexpected error

Success Response
{
  "data": [
    {
      "description": "Requirement for providing Proof of Address",
      "field_type": "address",
      "label": "Proof of Address",
      "record_type": "regulatory_requirement",
      "requirement_type": "end user proof of address"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Get Detailed Number Order Regulatory RequirementretrieveNumberOrderRegulatoryRequirement

get https://api.telnyx.com/v2/regulatory_requirements/{requirement_id}

Gets a single Number Order Regulatory Requirement

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/regulatory_requirements/{requirement_id}"
Parameters
In path
requirement_id
string
required

The number order regulatory requirement id

Responses
200

Number order regulatory requirement was found

default

Unexpected error

Success Response
{
  "data": {
    "description": "Requirement for providing Proof of Address",
    "field_type": "address",
    "label": "Proof of Address",
    "record_type": "regulatory_requirement",
    "requirement_type": "end user proof of address"
  }
}

Get Regulatory Requirements Per NumberlistPhoneNumberRegulatoryRequirements

get https://api.telnyx.com/v2/phone_number_regulatory_requirements

Gets a paginated list of Phone Number Regulatory Requirements

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/phone_number_regulatory_requirements?filter[phone_number]=+19705555098"
Parameters
In query
filter[phone_number]
array of string
optional

The list of phone numbers to retrieve regulatory requirements for

Responses
200

Returns a list of number order regulatory requirements

default

Unexpected error

Success Response
{
  "data": [
    {
      "phone_number": "+19705555098",
      "record_type": "phone_number_regulatory_requirement",
      "regulatory_group_id": "d70873cd-7c98-401a-81b6-b1ae08246995",
      "regulatory_requirements": [
        {
          "description": "Requirement for providing Proof of Address",
          "field_type": "address",
          "label": "Proof of Address",
          "record_type": "regulatory_requirement",
          "requirement_type": "end user proof of address"
        }
      ]
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Was this section helpful?was-this-page-helpful