Anexar um documento complementar baseado em um modelo
Use um modelo de get_supporting_document_templates e uma identidade que já pertença à sua conta. Envie os arquivos do documento por meio de create_encrypt_files usando supporting_template_id. Os envios comuns de comprovantes de identidade ou endereço pertencem a outra categoria e não podem ser usados em substituição.
Criar o documento complementar
Use uma conta habilitada da API da MultiTEL e o endereço IP permitido para ela. Os exemplos usam credenciais de autenticação HTTP Basic obtidas de variáveis de ambiente; siga as convenções de autenticação correspondentes ao seu tipo de conta. Envie as solicitações por HTTPS. Verifique tanto a resposta HTTP quanto o seguinte campo do objeto JSON: status.code; erros da aplicação podem ser recebidos com HTTP 200. Os exemplos abaixo são fictícios.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--header 'Content-Type: application/json' \
--data @supporting-request.json \
https://api.multitel.net/v3/create_supporting_document{
"identity_id": "33333333333333333333333333333333",
"template_id": "55555555555555555555555555555555",
"encrypted_file_ids": [
"66666666666666666666666666666666"
]
}| Campo | Significado |
|---|---|
identity_id | Identificador obrigatório da identidade associada à sua conta. Esta solicitação anexa o documento a uma identidade, não diretamente a um endereço ou número de telefone. |
template_id | Identificador obrigatório do modelo de documento complementar; use o mesmo modelo selecionado para o envio complementar. O campo para anexar o documento é template_id, enquanto o campo para enviá-lo é supporting_template_id. |
encrypted_file_ids | Lista JSON obrigatória e não vazia com os identificadores retornados dos arquivos enviados. Cada arquivo deve pertencer à conta atual, estar dentro do prazo de validade e ter a categoria supporting_documents. |
Também são aceitos dados de formulário com campos encrypted_file_ids[] repetidos. Não envie os bytes dos arquivos para este ponto de acesso de anexação de documentos.
Documento complementar criado
{
"status": {
"code": 200,
"msg": "Supporting document created successfully."
},
"response": {
"id": "77777777777777777777777777777777",
"template_id": "55555555555555555555555555555555",
"identity_id": "33333333333333333333333333333333",
"template_name": "Example supporting template"
}
}Isso confirma a criação do documento complementar, não sua aprovação regulatória nem a ativação do número. O termo «permanente» no recurso do sistema de origem não constitui uma garantia ao cliente sobre a duração do armazenamento ou a política de exclusão.
Erros e novas tentativas
O código 500 da API indica dados de entrada ausentes, erros da operadora ou uma resposta inválida da operadora. O código 404 indica uma identidade não associada à conta, um modelo inválido, arquivos enviados ausentes, expirados ou de categoria incorreta, ou um conjunto vazio de arquivos utilizáveis. Verifique status.msg; HTTP 200 por si só não é suficiente.
Envie e anexe os arquivos dentro do prazo de validade das referências de arquivo retornadas. Se receber uma resposta que não permita determinar o resultado, verifique os documentos complementares da identidade no portal antes de tentar novamente. Este manipulador não disponibiliza nenhuma chave de idempotência.