Instrucciones de integración de la API de verificación de fotos de identificación

​

Proceso de solicitud

📘 Documentación completa: API de verificación de fotos de identificación →

​

Uso básico

• accept: el formato de respuesta que deseas recibir, aquí se establece como application/json, es decir, en formato JSON.
• authorization: la clave para llamar a la API, que puedes seleccionar directamente después de solicitarla.

• image_url: el enlace de la imagen de la identificación que necesita ser procesada.
• config: opciones de configuración opcionales, campo booleano, por defecto todos son false, soporta copy_warn, border_check_warn, reshoot_warn, detect_ps_warn, temp_id_warn, quality (umbral de 0-100).

{
  "sim": 99.76,
  "result": "Success",
  "description": "Éxito",
  "name": "Nombre en la identificación",
  "sex": "Sexo en la identificación",
  "nation": "Nacionalidad en la identificación",
  "birth": "Fecha de nacimiento en la identificación",
  "address": "Dirección en la identificación",
  "id_num": "Número de identificación",
  "portrait": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBA.....DEhE2lbPMcOtG3f/DLT/yX8if7Kxn/AD7h85wdttPifRf1e6//2Q==",
  "warnings": "",
  "quality": 0,
  "encryption": null
}

• sim, similitud, rango de valores [0.00, 100.00]. Se recomienda que una similitud mayor o igual a 70 se considere como la misma persona, y puedes ajustar el umbral según el escenario específico (la tasa de falsos positivos para un umbral de 70 es de uno en mil, y para un umbral de 80 es de uno en diez mil).
• result, código de error del negocio, en caso de éxito devuelve “Success”, en caso de error consulta la sección de códigos de error en la lista de FailedOperation a continuación.
• description, resultado de la verificación del nombre y número de identificación.
• name, información del nombre en la identificación, si no se ha subido la imagen de la identificación, estará vacío.
• sex, información del sexo en la identificación, si no se ha subido la imagen de la identificación, estará vacío.
• nation, información de la nacionalidad en la identificación, si no se ha subido la imagen de la identificación, estará vacío.
• birth, información de la fecha de nacimiento en la identificación, si no se ha subido la imagen de la identificación, estará vacío.
• address, información de la dirección en la identificación, si no se ha subido la imagen de la identificación, estará vacío.
• id_num, información del número de identificación en la identificación, si no se ha subido la imagen de la identificación, estará vacío.
• portrait, codificación base64 de la foto de la cara de la identificación, si la extracción de la imagen falla, se comparará con la imagen completa de la identificación y se devolverá vacío.
• warnings, información de advertencia, cuando se configura información de advertencia en Config, se detendrá la comparación de imágenes y el resultado devolverá un error (FailedOperation.OcrWarningOccurred) junto con esta información de advertencia.
• quality, puntuación de calidad de la imagen, cuando se configura la advertencia de imagen borrosa en la solicitud, este parámetro tiene sentido, rango de valores (0-100), actualmente el umbral predeterminado es 50, y por debajo de 50 se activará la advertencia de borrosidad.
• encryption, información de cifrado de datos sensibles.

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}
}'

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)

​

Manejo de errores

• 400 token_mismatched: Solicitud incorrecta, posiblemente debido a parámetros faltantes o inválidos.
• 400 api_not_implemented: Solicitud incorrecta, posiblemente debido a parámetros faltantes o inválidos.
• 401 invalid_token: No autorizado, token de autorización inválido o faltante.
• 429 too_many_requests: Demasiadas solicitudes, has superado el límite de tasa.
• 500 api_error: Error interno del servidor, algo salió mal en el servidor.

​

Ejemplo de respuesta de error

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​

Conclusión