Saltar para o conteúdo principal
Este documento apresentará uma descrição da API de identificação e verificação de informações do CPF, que pode validar a autenticidade e a consistência do nome e do número do CPF através da entrada de uma imagem do CPF ou do nome e número do CPF. Esta interface é utilizada para verificar a autenticidade e a consistência do nome e do número do CPF, você pode fornecer as informações necessárias para validação inserindo o nome e o número do CPF ou enviando uma foto do rosto do portador do CPF.

​
Processo de Solicitação

Para usar a API, você precisa primeiro acessar a página correspondente da API de Identificação e Verificação de Informações do CPF para solicitar o serviço correspondente. Após entrar na página, clique no botão “Adquirir”, como 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 login ou registro, 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 CPF para obter o resultado de validação processado. Primeiro, você precisa passar um campo image_url, e em seguida, podemos preencher o conteúdo correspondente na interface, como 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:
  • image_url: o link da imagem do CPF a ser processada.
  • encryption: opcional, parâmetro de criptografia para campos sensíveis (se necessário enviar dados criptografados).
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 “Tentar” para realizar o teste, como mostrado na imagem acima, e aqui obtemos o seguinte resultado: 
{
  "result": "0",
  "description": "Nome e número do CPF são consistentes",
  "name": "Nome no CPF",
  "id_card": "Número do CPF",
  "sex": "Sexo no CPF",
  "nation": "Nacionalidade no CPF",
  "birth": "Data de nascimento no CPF",
  "address": "Endereço no CPF"
}
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 de resultado cobrados:
      • 0: Nome e número do CPF são consistentes
      • -1: Nome e número do CPF não são consistentes
    • Códigos de resultado não cobrados:
      • -2: Número do CPF 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 do CPF 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 CPF.
  • name, informação do nome no CPF, que estará vazia se a imagem do CPF não for enviada.
  • id_card, informação do número do CPF no CPF, que estará vazia se a imagem do CPF não for enviada.
  • sex, informação de sexo no CPF, que estará vazia se a imagem do CPF não for enviada.
  • nation, informação de nacionalidade no CPF, que estará vazia se a imagem do CPF não for enviada.
  • birth, informação de data de nascimento no CPF, que estará vazia se a imagem do CPF não for enviada.
  • address, informação de endereço no CPF, que estará vazia se a imagem do CPF não for enviada.
Pode-se observar que as informações do nome e do número do CPF são consistentes e válidas, e também foram extraídas outras informações utilizando tecnologia OCR e exibidas. 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: 
curl -X POST 'https://api.acedata.cloud/identity/idcard/ocr' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "image_url": {image_url}
}'
O código de integração em Python é o seguinte: 
import requests

url = "https://api.acedata.cloud/identity/idcard/ocr"

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

payload = {
    "image_url": {image_url}
}

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

​
Verificação de Informações Personalizadas

Também oferecemos uma maneira de verificar sem divulgar informações da imagem do CPF, podendo apenas enviar o nome name e o número do CPF id_card para validar a autenticidade e a consistência do nome e do número do CPF. Abaixo estão as informações preenchidas:

Após clicar em executar, obtemos o seguinte resultado: 
{
    "address": "",
    "birth": "",
    "description": "Nome e número do CPF são consistentes",
    "id_card": "Número do CPF",
    "name": "Nome no CPF",
    "nation": "",
    "result": "0",
    "sex": ""
 }
Assim, a partir do resultado, não serão divulgadas outras informações privadas, e isso também pode completar a verificação da autenticidade e consistência do nome e do número do CPF.

​
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: 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 Identificação e Verificação de Informações do CPF para validar a autenticidade e a consistência do nome e do número do CPF a partir de uma imagem ou informações do nome e número do CPF. Esperamos que este documento possa ajudá-lo a integrar e usar melhor esta API. Se tiver alguma dúvida, entre em contato com nossa equipe de suporte técnico.