Consultar os requisitos de registo

Selecione o país e o tipo de número

Escolha um país de registo e, em seguida, utilize um nome devolvido por get_document_number_types. Envie esse nome como number_type, e não um identificador de tipo nem uma categoria geral de pesquisa de números.

Leia as instruções devolvidas

Guarde os identificadores dos requisitos e das relações para o fluxo de trabalho de identidade e documentos correspondente. Esta chamada devolve requisitos; não valida nem submete os seus ficheiros. Siga as instruções devolvidas e quaisquer requisitos específicos do número selecionado.

Não interprete um erro como uma isenção

O erro relativo a um país inválido ou à ausência de documentos de registo do país combina duas condições. Não prova que o registo seja desnecessário. Uma falha na consulta ou um resultado vazio também não constitui a aprovação de um cliente ou de um número. Contacte o suporte se o resultado não for claro.

Pedido

Utilize as credenciais da sua conta de API ativada através de HTTPS. São suportados a autenticação básica e os tokens de portador ativados da conta de API; aplicam-se as restrições da conta.

POST com application/json ou 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"

Parâmetros do corpo
Nome	Tipo	Obrigatório	Descrição
`country`	cadeia de caracteres	Sim	Código ISO do país obtido de get_document_countries.
`number_type`	cadeia de caracteres	Sim	Nome de tipo obtido de get_document_number_types, como Local; a comparação não distingue maiúsculas de minúsculas. Forneça o nome, não o respetivo identificador.

Resposta

Verifique status.code no corpo JSON, bem como o estado HTTP. response é um único recurso de requisitos com id, type e attributes, além de relationships quando são devolvidas. Os identificadores nos dados do recurso e das relações são opacos. As etiquetas HTML são removidas do texto opcional de restriction_message; trate o texto restante como texto, não como HTML de confiança. O processador devolve o primeiro recurso de requisitos, pelo que não deve deduzir que esta resposta é uma lista exaustiva. A disponibilidade de atributos e relações depende do país e do tipo; o exemplo não constitui um esquema fixo completo.

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

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

Erros

400: A validação do país e de number_type falhou: forneça ambos os valores obrigatórios. O texto de validação pode conter formatação.
400: Invalid country ISO or No country registration documents required.: esta mensagem ambígua não prova, por si só, que exista uma isenção de registo.
400: Invalid number type: utilize um nome de tipo devolvido. O erro antigo enumera Global, Local, Mobile, National, Shared Cost e Toll Free.
500: Unable to load registration requirements for the specified country and number type.: os requisitos não foram devolvidos com êxito. Tente novamente mais tarde ou contacte o suporte.

Disponibilidade e efeitos secundários

Esta consulta do catálogo e dos requisitos não cria uma identidade, não carrega um comprovativo, não regista um número nem efetua uma encomenda.
Uma resposta bem-sucedida do catálogo não constitui a aprovação dos seus documentos nem confirma que um número selecionado pode ser ativado.