Escolha uma categoria de comprovativos
Utilize a categoria e o tipo de entidade devolvidos ao preparar a documentação comprovativa exigida para uma identidade. Esta lista descreve categorias; não enumera os ficheiros que carregou nem implica a aprovação de qualquer comprovativo.
Cumpra os requisitos aplicáveis
O facto de uma categoria constar da lista não significa que satisfaça os requisitos de todos os países, tipos de número ou identidades de cliente. Leia os requisitos aplicáveis antes de carregar a documentação comprovativa e trate os identificadores devolvidos como valores opacos.
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 para a conta de API; aplicam-se as restrições da conta.
GET com qualquer parâmetro documentado no caminho do URL.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/get_proof_types"Resposta
Verifique status.code no corpo JSON, bem como o estado HTTP. response é uma matriz de objetos com os campos id, name e entity_type. Estes valores provêm do catálogo atual de comprovativos. Os identificadores são opacos; copie-os em vez de os construir ou gerar através de uma função de hash. Um catálogo vazio pode ser devolvido com sucesso. Não defina de forma fixa no código uma enumeração completa de tipos de entidade a partir deste exemplo.
Estrutura ilustrativa da resposta; não contém dados da conta em tempo real nem constitui uma cotação em vigor.
{
"status": {
"code": 200,
"msg": "",
"results": 1
},
"response": [
{
"id": "PROOF_TYPE_ID_FROM_RESPONSE",
"name": "Example proof category",
"entity_type": "ENTITY_TYPE_FROM_RESPONSE"
}
]
}Erros
- Verifique status.code e status.msg para detetar erros de autenticação ou do serviço. Um catálogo vazio devolvido com sucesso não implica a aprovação de um documento nem uma isenção de registo.
Disponibilidade e efeitos secundários
- Esta consulta do catálogo ou 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 implica a aprovação dos seus documentos nem confirma que um número selecionado possa ser ativado.