Saltar para o conteúdo principal
Este documento apresentará uma integração da API de Informação de Identidade e Verificação de Validade, que pode ser usada para verificar a autenticidade e a consistência do nome, número do documento de identidade e validade do documento.

​
Processo de Solicitação

Para usar a API, você precisa primeiro acessar a página correspondente da API de Informação de Identidade e Verificação de Validade para solicitar o serviço correspondente. Após entrar na página, clique no botão “Adquirir”, conforme mostrado na imagem: Se você ainda não estiver logado ou registrado, será redirecionado automaticamente para a página de login, convidando-o a se registrar e fazer login. Após o registro e login, você será redirecionado de volta para a página atual. Na primeira solicitação, haverá um limite gratuito disponível, permitindo o uso gratuito da API.

​
Uso Básico

Primeiro, entenda a forma básica de uso, que é inserir o link da imagem do documento de identidade para obter o resultado de verificação processado. Primeiro, você precisa passar um campo name, e em seguida, podemos preencher o conteúdo correspondente na interface, conforme mostrado na imagem:

Podemos ver que aqui configuramos os Headers da Requisição, incluindo:
  • accept: o formato de resposta desejado, aqui preenchido como application/json, ou seja, formato JSON.
  • authorization: a chave para chamar a API, que pode ser selecionada diretamente após a solicitação.
Além disso, configuramos o Corpo da Requisição, incluindo:
  • name: nome.
  • id_card: número do documento de identidade.
  • image_url: link da imagem do rosto a ser processada.
  • validity_end: data de validade do documento de identidade, formato: YYYYMMDD, use “00000000” para validade indefinida;
  • validity_begin: data de início da validade do documento de identidade, formato: YYYYMMDD.
  • encryption: opcional, parâmetro de criptografia para campos sensíveis (se necessário enviar dados criptografados).
Após a seleção, você pode notar que o código correspondente também foi gerado à direita, conforme mostrado na imagem:

Clique no botão “Tentar” para realizar o teste, como mostrado na imagem acima, e aqui obtivemos o seguinte resultado: 
{
  "result": "0",
  "description": "Consistente"
}
O resultado retornado possui vários campos, descritos a seguir:
  • result, código do resultado da autenticação, com as seguintes condições de cobrança.
    • Códigos de resultado com cobrança:
      • 0: Nome e número do documento de identidade consistentes
      • -1: Nome e número do documento de identidade não consistentes
    • Códigos de resultado sem cobrança:
      • -2: Número do documento de identidade inválido (comprimento, dígito de verificação, etc. incorretos)
      • -3: Nome inválido (comprimento, formato, etc. incorretos)
      • -4: Serviço de banco de dados de documentos anômalo
      • -5: Registro de documento de identidade não encontrado no banco de dados
      • -6: Sistema de comparação autoritativa em atualização, por favor, tente novamente mais tarde
      • -7: Número de autenticações excedeu o limite diário.
  • description, resultado da verificação do nome e número do documento de identidade.
Pode-se observar que o nome, número do documento de identidade e validade do documento possuem autenticidade e consistência. Além disso, se você deseja gerar o código de integração correspondente, pode copiá-lo diretamente, por exemplo, o código CURL é o seguinte: 
curl -X POST 'https://api.acedata.cloud/identity/idcard/check-2e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "id_card": "***",
  "validity_begin": "***",
  "validity_end": "***"
}'
O código de integração em Python é o seguinte: 
import requests

url = "https://api.acedata.cloud/identity/idcard/check-2e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "name": "***",
    "id_card": "***",
    "validity_begin": "***",
    "validity_end": "***"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

​
Tratamento de Erros

Ao chamar a API, se ocorrer um erro, a API retornará o código de erro e a mensagem correspondente. Por exemplo:
  • 400 token_mismatched: Solicitação inválida, possivelmente devido a parâmetros ausentes ou inválidos.
  • 400 api_not_implemented: Solicitação inválida, possivelmente devido a parâmetros ausentes ou inválidos.
  • 401 invalid_token: Não autorizado, token de autorização inválido ou ausente.
  • 429 too_many_requests: Muitas solicitações, você excedeu o limite de taxa.
  • 500 api_error: Erro interno do servidor, algo deu errado no servidor.

​
Exemplo de Resposta de Erro

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "falha na busca"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
Conclusão

Através deste documento, você já entendeu como usar a API de Informação de Identidade e Verificação de Validade para verificar a autenticidade e a consistência do nome, número do documento de identidade e validade do documento. Esperamos que este documento possa ajudá-lo a integrar e usar melhor a API. Se tiver alguma dúvida, entre em contato com nossa equipe de suporte técnico.