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

phone_numberstring

Phone number to check requirements for

requirement_group_idstring

ID of requirement group to check requirements for

country_codestring

Country code(iso2) to check requirements for

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

Phone number type to check requirements for

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

Action 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]

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

Response

An array of Regulatory Requirements Responses

Example response

{
  "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",
            "max_length": "10",
            "min_length": "5"
          }
        }
      ]
    }
  ]
}

Changes

Changed in 3 of the 99 revisions of this API.251025

  • a6a61a29ecdd5510See the full diff
    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

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

  • 1571b0380bd7155See the full diff
    • ▲

      the response property // became optional for the status

      response-property-became-optional

    • ▲

      the response property // became optional for the status

      response-property-became-optional

    • ▲

      the response property // became optional for the status

      response-property-became-optional

    • ▲

      the response property // became optional for the status

      response-property-became-optional

    • ▲

      the response property // became optional for the status

      response-property-became-optional

    • ▲

      the response property // became optional for the status

      response-property-became-optional

    • ▲

      the response property // became optional for the status

      response-property-became-optional

    • ▲

      the response property // became optional for the status

      response-property-became-optional

    • ▲

      the response property // became optional for the status

      response-property-became-optional

    • ▲

      the response property // became optional for the status

      response-property-became-optional

    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      response-property-type-changed

    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      response-property-type-changed

    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      response-property-type-changed

    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      response-property-type-changed

    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      response-property-type-changed

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the 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 // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      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

Of the 99 revisions, 1 has no diff computed.