Saltar para o conteúdo principal
Este documento apresentará uma API de verificação de foto de identidade, que pode ser usada para enviar fotos do rosto do documento de identidade, reconhecer as informações na foto do documento e comparar o nome, número do documento de identidade e foto do rosto com as fotos de documentos da base de dados autorizada, para verificar se pertencem à mesma pessoa, validando assim a autenticidade das informações do documento de identidade.

​
Processo de Solicitação

Para usar a API, você precisa primeiro acessar a página correspondente da API de Verificação de Foto de Identidade para solicitar o serviço correspondente. Após entrar na página, clique no botão “Acquire”, 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 registro e login, você será redirecionado de volta para a página atual. Na primeira solicitação, haverá um crédito 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 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 documento de identidade a ser processada.
  • config: opções de configuração opcionais, campos booleanos, todos com valor padrão como false, suportando copy_warn, border_check_warn, reshoot_warn, detect_ps_warn, temp_id_warn, quality (limite de 0-100).
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: 
{
  "sim": 99.76,
  "result": "Success",
  "description": "成功",
  "name": "身份证姓名",
  "sex": "身份证性别",
  "nation": "身份证民族",
  "birth": "身份证生日",
  "address": "身份证家庭住址",
  "id_num": "身份证号码",
  "portrait": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBA.....DEhE2lbPMcOtG3f/DLT/yX8if7Kxn/AD7h85wdttPifRf1e6//2Q==",
  "warnings": "",
  "quality": 0,
  "encryption": null
}
O resultado retornado possui vários campos, descritos a seguir:
  • sim, similaridade, intervalo de valores [0.00, 100.00]. Recomenda-se que uma similaridade maior ou igual a 70 possa ser considerada como a mesma pessoa, podendo ajustar o limite conforme o cenário específico (a taxa de erro para um limite de 70 é de um em mil, e para um limite de 80 é de um em dez mil).
  • result, código de erro de negócio, retornando “Success” em caso de sucesso, e em caso de erro, consulte a lista de códigos de erro na seção FailedOperation abaixo.
  • description, resultado da verificação do nome e número do documento de identidade.
  • name, informação do nome no documento de identidade, que será vazia se a imagem do documento não for enviada.
  • sex, informação de gênero no documento de identidade, que será vazia se a imagem do documento não for enviada.
  • nation, informação de nacionalidade no documento de identidade, que será vazia se a imagem do documento não for enviada.
  • birth, informação de data de nascimento no documento de identidade, que será vazia se a imagem do documento não for enviada.
  • address, informação de endereço no documento de identidade, que será vazia se a imagem do documento não for enviada.
  • id_num, informação do número do documento de identidade, que será vazia se a imagem do documento não for enviada.
  • portrait, codificação base64 da foto do rosto do documento de identidade, que será comparada com a imagem inteira do documento se a extração falhar e retornará vazia.
  • warnings, informações de alerta, quando configuradas no Config, a comparação de rosto será interrompida, e o resultado retornará um erro (FailedOperation.OcrWarningOccurred) com esta informação de alerta.
  • quality, pontuação de qualidade da imagem, quando configurada no Config para alerta de imagem borrada, este parâmetro é significativo, com intervalo de valores (0-100), atualmente o limite padrão é 50, e abaixo de 50 acionará um alerta de borrão.
  • encryption, informações de criptografia de dados sensíveis.
Pode-se observar que as informações do documento de identidade possuem alta autenticidade. 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/check-1e' \
-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/check-1e"

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)

​
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": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
Conclusão

Através deste documento, você já entendeu como usar a API de Verificação de Foto de Identidade para enviar fotos do rosto do documento de identidade, reconhecer as informações na foto do documento e comparar o nome, número do documento de identidade e foto do rosto com as fotos de documentos da base de dados autorizada, para verificar se pertencem à mesma pessoa, validando assim a autenticidade das informações do documento de identidade. 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.