MultiTEL
Developers

GET/v3/get_document_number_types/{country}

List registration number types

Find the number-type names currently represented in the registration catalogue for a country.

On this page
  1. Choose a type by its returned name
  2. Group counts are not number inventory
  3. Request
  4. Response
  5. Errors
  6. Availability and side effects

Choose a type by its returned name

Use a country from get_document_countries. Pass the returned type name to get_requirements. A type catalogue ID is not a prefix ID, number ID or proof-category ID.

Group counts are not number inventory

available_groups counts the group records returned by this catalogue lookup. It does not count purchasable phone numbers, reserve stock or guarantee that the catalogue has exhausted upstream pages. Search the relevant number inventory and review a quote separately.

Request

Use your enabled API account credentials over HTTPS. Basic authentication and enabled API-account bearer tokens are supported; account restrictions apply.

GET with any documented parameter in the URL path.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"
Path parameters
NameTypeRequiredDescription
countrystringYesTwo-letter country ISO code from the registration-country catalogue. It is trimmed and uppercased.

Response

Check status.code in the JSON body as well as the HTTP status. response is an array containing id, name and available_groups. Use name as number_type when calling get_requirements; do not send id in its place. available_groups is the number of group records returned for that type, not a telephone-number stock count or a complete paginated total. Types with no returned groups are omitted. The preferred order is Local, Mobile, National, Toll Free, Shared Cost, Global, followed by other catalogue names.

Illustrative response shape; not live account data or a current quote.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "NUMBER_TYPE_ID_FROM_RESPONSE",
      "name": "Local",
      "available_groups": 3
    }
  ]
}

Errors

  • 400: country is required: supply the registration-country ISO code.
  • 400: Invalid country ISO or no available DID registration country found: select a country from the current registration catalogue; this does not establish that no documents are required.

Availability and side effects

  • This catalogue/requirements lookup does not create an identity, upload a proof, register a number or place an order.
  • A successful catalogue response is not approval of your documents or confirmation that a selected number can be activated.