Listar modelos de documentos comprobatórios

Consulte o catálogo de modelos

Omita o segmento ISO opcional do caminho para listar os modelos retornados pelo serviço. Forneça um código ISO de país para filtrar a lista. O filtro procura correspondências na indicação de país do modelo, que pode ser inferida a partir de um nome e pode estar vazia.

Use os requisitos para escolher um modelo

A presença de um modelo não significa que ele seja obrigatório ou aceito para todos os números desse país. Relacione o ID do modelo aos requisitos aplicáveis de documentos comprobatórios. Esta lista não gera, assina, envia nem aprova um documento preenchido.

Se nenhum modelo for retornado

Uma lista filtrada vazia pode significar que não foi encontrada nenhuma indicação de país correspondente. Uma lista não filtrada vazia também pode refletir a indisponibilidade de dados na fonte consultada. Não interprete nenhum desses resultados como prova de que nenhum documento comprobatório é necessário.

Revise uma cópia baixada antes de usá-la

Um link de download do catálogo pode retornar uma cópia com alterações de formatação ou de identidade visual. Não presuma que se trata de um contrato original sem alterações nem que baixá-lo cumpre um requisito de registro. Revise o conteúdo antes de preencher ou assinar qualquer documento.

Quando o assistente de documentos do portal oferecer a preparação de contratos, use a pré-visualização e o fluxo de envio explícito desse assistente. Para outros formulários obrigatórios, confirme o formulário vigente com a MultiTEL antes de preenchê-lo. Um modelo baixado não é um anexo assinado, um comprovante enviado nem uma aprovação de um número.

Solicitação

Use as credenciais da sua conta de API habilitada por HTTPS. Há suporte para autenticação Basic e tokens bearer habilitados para a conta de API; aplicam-se as restrições da conta.

GET com qualquer parâmetro documentado no caminho da URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_supporting_document_templates/$COUNTRY_ISO"

Parâmetros do caminho
Nome	Tipo	Obrigatório	Descrição
`iso`	string	Não	Filtro opcional por código ISO de país. Omita este segmento inteiro do caminho para obter a lista sem filtro. A comparação não diferencia maiúsculas de minúsculas. Valores desconhecidos ou sem correspondência retornam uma lista vazia em vez de um erro explícito de país inválido.

Resposta

Verifique status.code no corpo JSON, bem como o status HTTP. response é um array de objetos com id, name, permanent, iso e url. permanent é do tipo boolean; iso pode estar vazio e pode ter sido inferido a partir do nome do modelo. Trate as informações de país como uma indicação, não como uma decisão de elegibilidade. Um catálogo vazio é uma resposta bem-sucedida com código 200 e também pode ocorrer quando a consulta à fonte de dados não retorna dados. A URL é gerada pelo serviço; o nome do host pode ser diferente do exemplo ilustrativo.

Estrutura de resposta ilustrativa; não representa dados da conta em tempo real nem uma cotação atual.

{
  "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"
    }
  ]
}

Erros

Verifique status.code e status.msg para identificar erros de autenticação ou do serviço. Um catálogo vazio retornado com sucesso não constitui aprovação de um documento nem dispensa de registro.

Disponibilidade e efeitos colaterais

Esta consulta ao catálogo ou aos requisitos não cria uma identidade, não envia um comprovante, não registra um número nem faz um pedido.
Uma resposta bem-sucedida do catálogo não constitui aprovação dos seus documentos nem confirmação de que um número selecionado pode ser ativado.