v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Regulatory Requirements

Retrieve regulatory requirements

get/regulatory_requirements

Query parameters

action'ordering' | 'porting' | 'action'

Action to check requirements for

country_codestring

Country code(iso2) to check requirements for

phone_numberstring

Phone number to check requirements for

phone_number_type'local' | 'toll_free' | 'mobile' | 'national' | 'shared_cost'

Phone number type to check requirements for

requirement_group_idstring

ID of requirement group to check requirements for

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

{
  "country_code": "DE",
  "phone_number": "+41215470622",
  "requirement_group_id": "d4c0b4a6-7bd2-40c5-a3b9-2acd99e212b2"
}

Response

An array of Regulatory Requirements Responses

Example response

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