Skip to main content
Este documento apresenta uma instrução para integração da API de Reconhecimento e Verificação de Identidade, que pode validar a autenticidade e consistência do nome e número de identidade através da imagem do documento ou do nome e número de identidade. Esta interface é usada para verificar a autenticidade e consistência do nome e número de identidade, podendo fornecer as informações necessárias para validação através do nome e número de identidade ou da foto do lado do retrato do documento.

​
Processo de Solicitação

Para usar a API de Reconhecimento e Verificação de Identidade, primeiro acesse o Console Ace Data Cloud para obter seu Token de API para uso futuro. Se você ainda não estiver logado ou registrado, será redirecionado automaticamente para a página de login para se registrar e entrar, e após isso retornará automaticamente para esta página. Um único Token de API pode ser usado para chamar todos os serviços da plataforma, não é necessário solicitar separadamente para cada serviço. Na primeira solicitação, será concedida uma cota gratuita para teste; quando a cota acabar, você pode recarregar saldo geral no Console.
📘 Documentação completa: API de Reconhecimento e Verificação de Identidade →

​
Uso Básico

Primeiro, entenda o modo básico de uso, que é inserir o link da imagem do documento para obter o resultado da validação processada. Inicialmente, é necessário passar um campo image_url simples, e então podemos preencher o conteúdo correspondente na interface, conforme mostrado na figura:

Aqui configuramos os Cabeçalhos da Requisição, incluindo:
  • accept: o formato desejado para a resposta, 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.
Também configuramos o Corpo da Requisição, incluindo:
  • image_url: o link da imagem do documento a ser processada.
  • encryption: opcional, parâmetro para criptografia de campos sensíveis (se for necessário enviar texto cifrado).
Após a seleção, você pode ver que o código correspondente é gerado no lado direito, conforme mostrado na figura:

Clique no botão “Try” para testar, conforme mostrado na figura acima, e obteremos o seguinte resultado:
O resultado retornado contém vários campos, descritos a seguir:
  • result, código do resultado da autenticação, com as seguintes condições de cobrança.
    • Códigos cobrados:
      • 0: Nome e número de identidade coincidem
      • -1: Nome e número de identidade não coincidem
    • Códigos não cobrados:
      • -2: Número de identidade inválido (comprimento, dígito verificador incorreto, etc.)
      • -3: Nome inválido (comprimento, formato, etc.)
      • -4: Serviço da base de dados do documento com erro
      • -5: Nenhum registro deste documento na base de dados
      • -6: Sistema de comparação oficial em atualização, tente novamente mais tarde
      • -7: Limite diário de autenticações excedido.
  • description, resultado da validação do nome e número de identidade.
  • name, nome no documento, vazio se a imagem do documento não for enviada.
  • id_card, número do documento, vazio se a imagem do documento não for enviada.
  • sex, sexo no documento, vazio se a imagem do documento não for enviada.
  • nation, nacionalidade no documento, vazio se a imagem do documento não for enviada.
  • birth, data de nascimento no documento, vazio se a imagem do documento não for enviada.
  • address, endereço residencial no documento, vazio se a imagem do documento não for enviada.
Pode-se observar que o nome e número de identidade no documento são consistentes e válidos, e outras informações também são extraídas e exibidas usando tecnologia OCR. Além disso, se desejar gerar o código correspondente para integração, pode copiar diretamente o código gerado, por exemplo, o código CURL é o seguinte:
O código de integração em Python é o seguinte:

​
Verificação Personalizada de Informações

Também oferecemos uma forma de verificar sem expor a imagem do documento, podendo apenas enviar o nome name e o número de identidade id_card para validar a autenticidade e consistência do nome e número de identidade. Abaixo está a informação preenchida:

Após clicar em executar, obtemos o seguinte resultado:
Assim, pelo resultado, outras informações privadas não são expostas, e ainda é possível validar a autenticidade e consistência do nome e número de identidade.

​
Tratamento de Erros

Ao chamar a API, se ocorrer um erro, a API retornará o código e a mensagem de erro correspondentes. Por exemplo:
  • 400 token_mismatched: Requisição inválida, possivelmente por parâmetros ausentes ou inválidos.
  • 400 api_not_implemented: Requisição inválida, possivelmente por 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 requisições, limite de taxa excedido.
  • 500 api_error: Erro interno do servidor, algo deu errado no servidor.

​
Exemplo de Resposta de Erro

​
Conclusão

Com este documento, você já entendeu como usar a API de Reconhecimento e Verificação de Identidade para validar a autenticidade e consistência do nome e número de identidade a partir da imagem ou das informações de nome e número de identidade. Esperamos que este documento ajude você a integrar e usar melhor esta API. Se tiver qualquer dúvida, entre em contato com nossa equipe de suporte técnico a qualquer momento.