Skip to main content
GET
/
regulatory_requirements
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const regulatoryRequirement = await client.regulatoryRequirements.retrieve();

console.log(regulatoryRequirement.data);
{
  "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": "600 Congress Avenue, 14th Floor, Austin, TX 78701",
          "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"
          }
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter
object

Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[requirement_group_id], filter[country_code], filter[phone_number_type], filter[action]

Response

An array of Regulatory Requirements Responses

data
object[]