Skip to main content
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 consistência do nome, número do documento de identidade e validade do documento.

​
Processo de Solicitação

Para usar a API de Informação de Identidade e Verificação de Validade, primeiro acesse o Painel de Controle da Ace Data Cloud para obter seu Token de API, que deve ser guardado para uso futuro. 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 a conclusão, você será redirecionado de volta para a página atual. Um Token de API é suficiente para acessar todos os serviços da plataforma, não sendo necessário solicitar um para cada serviço individualmente. A primeira solicitação oferece um crédito gratuito, permitindo uma experiência sem custo; quando o crédito estiver baixo, você pode recarregar o saldo geral no painel de controle.
📘 Documentação Completa: API de Informação de Identidade e Verificação de Validade →

​
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, é necessário passar um campo name, e em seguida, podemos preencher o conteúdo correspondente na interface, como mostrado na imagem:

Podemos ver que aqui configuramos os Cabeçalhos da Solicitaçã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 Solicitaçã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 em formato criptografado).
Após a seleção, podemos ver que o código correspondente também foi gerado à direita, como mostrado na imagem:

Clique no botão “Try” para realizar o teste, como mostrado na imagem acima, e aqui obtemos o seguinte resultado:
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 com anomalia
      • -5: Registro de documento de identidade não encontrado no banco de dados
      • -6: Sistema de comparação de autoridade 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ê quiser gerar o código de integração correspondente, pode copiá-lo diretamente, por exemplo, o código CURL é o seguinte:
O código de integração em Python é o seguinte:

​
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

​
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 consistência do nome, número do documento de identidade e validade do documento. Esperamos que este documento ajude você a integrar e usar melhor essa API. Se tiver alguma dúvida, entre em contato com nossa equipe de suporte técnico.