Regulatory Requirements

Retrieve regulatory requirements

Changed on

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

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/regulatory_requirements
  • Auth: HTTP bearer

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

  • 19db5ee4ec59Revision changes
    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

  • a6a61a29ecddRevision changes
    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status