Sign in
Regulatory Requirements

Retrieve regulatory requirements

Returns regulatory requirements for number ordering, porting, or other supported actions. Results can be filtered by phone number, requirement group, country, number type, and action.

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"
        }
      ]
    }
  ]
}

Changes

Changed in 2 of the 61 revisions of this API.20515

  • 1571b0380bd7155See the full diff
    • ▲

      the response property errors/items/code became optional for the status 400

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 401

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 404

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 422

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 500

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 400

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 401

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 404

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 422

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 500

      response-property-became-optional

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 400

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 401

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 404

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 500

      response-property-type-changed

    • ○

      added the optional property errors/items/meta/url to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 500 status

      response-optional-property-added

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379945510See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 400

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 401

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 404

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 500

      response-property-type-changed

    • ●

      removed the optional property errors/items/meta/url from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 401 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 404 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 500 status

      response-optional-property-removed

    • ○

      the response property errors/items/code became required for the status 400

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 401

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 404

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 422

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 500

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 400

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 401

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 404

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 422

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 500

      response-property-became-required

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog