Read registration requirements

Select the country and number type

Choose a registration country, then use a name returned by get_document_number_types. Send that name as number_type, not a type ID or a general number-discovery category.

Read the returned instructions

Keep the requirement and relationship IDs for the relevant identity/document workflow. This call returns requirements; it does not validate or submit your files. Follow the returned instructions and any requirements specific to the selected number.

Do not interpret an error as an exemption

The error about an invalid country or no country registration documents combines two conditions. It is not proof that registration is unnecessary. A lookup failure or empty result also does not approve a customer or a number. Contact support if the result is unclear.

Request

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

POST with application/json or application/x-www-form-urlencoded.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{"country":"US","number_type":"Local"}' \
  "https://api.multitel.net/v3/get_requirements"

Body parameters
Name	Type	Required	Description
`country`	string	Yes	Country ISO code from get_document_countries.
`number_type`	string	Yes	Type name from get_document_number_types, such as Local; matching ignores case. Supply the name, not its ID.

Response

Check status.code in the JSON body as well as the HTTP status. response is a single requirements resource with id, type and attributes, plus relationships when returned. IDs in the resource and relationship data are opaque. Optional restriction_message text has HTML tags removed; handle remaining text as text, not trusted HTML. The handler returns the first requirements resource, so do not infer that this response is an exhaustive list. Attribute/relationship availability is country- and type-dependent; the example is not a complete fixed schema.

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

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "id": "REQUIREMENT_ID_FROM_RESPONSE",
    "type": "RESOURCE_TYPE_FROM_RESPONSE",
    "attributes": {
      "restriction_message": "Example country-specific instructions."
    }
  }
}

Errors

400: Country and number_type validation failed: provide both required values. Validation text may contain formatting.
400: Invalid country ISO or No country registration documents required.: this ambiguous message does not by itself prove a registration exemption.
400: Invalid number type: use a returned type name. The legacy error lists Global, Local, Mobile, National, Shared Cost and Toll Free.
500: Unable to load registration requirements for the specified country and number type.: requirements were not returned successfully. Retry later or contact support.

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.