Developers

GET/v3/get_document_countries

List registration countries

Find country ISO codes and names offered by the current number-registration catalogue.

On this page
  1. Choose the registration country
  2. If a country is missing
  3. Request
  4. Response
  5. Errors
  6. Availability and side effects

Choose the registration country

Copy a country ISO code from this response before requesting number types or registration requirements. Use the country of the number service, not automatically the nationality or address country of the customer.

If a country is missing

A missing country is not proof that no documents are required or that MultiTEL cannot supply a number there. Keep registration selection separate from number discovery and contact support if the required country is unavailable.

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_countries"

Response

Check status.code in the JSON body as well as the HTTP status. response is an array of uppercase iso and name strings, sorted by name. This registration catalogue differs from number-stock discovery and from the general countries list used for addresses. It is not a promise that every country or every available page of upstream results has been returned.

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "iso": "US",
      "name": "United States"
    }
  ]
}

Errors

  • 500: Unable to load available registration countries: the registration-country lookup did not provide data. Retry later; do not treat this as an empty successful catalogue.

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.