List supporting-document templates

Browse the template catalogue

Omit the optional ISO path segment to list the templates returned by the service. Supply a country ISO code to filter the list. The filter matches the template country hint, which can be inferred from a name and can be empty.

Use the requirements to choose a template

A template being present does not mean it is required or accepted for every number in that country. Match the template ID to the applicable supporting-document requirements. This list does not generate, sign, upload or approve a completed document.

If no templates are returned

An empty filtered list may mean no matching country hint was found. An empty unfiltered list may also reflect unavailable upstream data. Do not treat either result as proof that no supporting document is required.

Review a downloaded copy before using it

A catalogue download link can return a copy with formatting or branding changes. Do not assume that it is an unchanged original agreement or that downloading it completes a registration requirement. Review the contents before filling in or signing any document.

Where the portal document wizard offers agreement preparation, use its preview and explicit submission workflow. For other required forms, confirm the current form with MultiTEL before completing it. A downloaded template is not a signed attachment, an uploaded proof or approval of a number.

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_supporting_document_templates/$COUNTRY_ISO"

Path parameters
Name	Type	Required	Description
`iso`	string	No	Optional country ISO filter. Omit this entire path segment for the unfiltered list. Comparison ignores case. Unknown or unmatched values return an empty list rather than an explicit invalid-country error.

Response

Check status.code in the JSON body as well as the HTTP status. response is an array of id, name, permanent, iso and url objects. permanent is a boolean; iso may be empty and may have been inferred from the template name. Treat country information as a hint, not an eligibility decision. An empty catalogue is a successful 200 response and can also result when the upstream lookup yields no data. The URL is generated by the service; its hostname may differ from the illustrative example.

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "TEMPLATE_ID_FROM_RESPONSE",
      "name": "Example supporting-document template",
      "permanent": false,
      "iso": "US",
      "url": "https://api.multitel.net/v3/supporting_document/TEMPLATE_ID_FROM_RESPONSE"
    }
  ]
}

Errors

Check status.code and status.msg for authentication or service errors. A successful empty catalogue is not approval of a document or a registration exemption.

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.