Documento de Integração da API de Verificação de Foto de Identidade

Documentation Index

Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Processo de Solicitação

​

Uso Básico

• 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.

• 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).

{
  "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
}

• 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.

curl -X POST 'https://api.xhuoapi.ai/v1/identity/idcard/check-1e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "image_url": {image_url}
}'

import requests

url = "https://api.xhuoapi.ai/v1/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

• 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