Skip to main content
POST
Python
La sección de la API de ID Liveness permite a los usuarios verificar la autenticidad de un documento de identidad analizando la imagen proporcionada en busca de signos de manipulación o falsificación. Los usuarios pueden aprovechar diferentes pipelines para detectar capturas de pantalla, copias impresas y reemplazos de retrato, garantizando la integridad del documento de identidad. Al completarse, los usuarios recibirán los resultados de reconocimiento e información de la transacción, facilitando procesos seguros de verificación de identidad.
Notas
Para verificar correctamente la autenticidad de una imagen, se requiere espacio en blanco alrededor del documento de identidad.
Si el documento ocupa toda la imagen sin espacio en blanco, es posible que no se produzcan resultados precisos.
Imagen de ejemplo:

Notas sobre la solicitud

  • En idImage, incluya los bytes del archivo de imagen codificados como una cadena base64. Envíe solo la cadena codificada, sin un prefijo como data:image/png;base64,.
  • sr, pc y ps dentro de pipelines son obligatorios y deben ser valores booleanos.
  • Si incluye callbackUrl, la solicitud se procesa de forma asíncrona y el resultado se entrega a esa URL. Para recibir el resultado directamente en la respuesta, no incluya callbackUrl.
  • Al probar en el playground, pegue la misma cadena base64 en el campo idImage.

Atributos de respuesta

string
Identificador único de la transacción asociada con la solicitud de reconocimiento.
string
Devuelve las puntuaciones de detección para cada pipeline.Valores de pipelines:
  • screenReplay - liveness_score
  • paperPrinted - liveness_score
  • replacePortraits - liveness_score
string
Identifica el error específico para facilitar la resolución de problemas.Valores de códigos de error:
  • 1001 - Workspace is unavailable
  • 1003 - Fail to process data
  • 1005 - idImage is required
  • 1007 - pipelines is required
  • 1008 - invalid pipelines format
  • 1009 - Fail to analyze document
  • 1010 - callbackUrl is required
string
Describe brevemente el error. Consulte el código de error para más detalles.

Autorizaciones

x-api-key
string
header
requerido

Cuerpo

application/json
idImage
string
requerido

The ID document image to analyze for liveness detection, as a base64-encoded string. Encode the bytes of the image file and send only the encoded string, without a data URI prefix such as data:image/png;base64,. The image should contain a clear view of the ID document.

pipelines
object
requerido

Forgery detection options object

useUpcomingVersion
boolean
predeterminado:false

Use the upcoming version of the liveness engine

callbackUrl
string<uri>

Optional callback URL where the liveness detection results will be sent upon completion. If provided, the process works asynchronously.

Ejemplo:

"https://your-domain.com/callback"

Respuesta

Successful liveness detection analysis

apiType
string
Ejemplo:

"id_live_doc"

transactionId
string

Unique transaction identifier

Ejemplo:

"txn_123456789"

engineVersion
string

Liveness Engine's version for each request

Ejemplo:

"id_liveness@3.4.2"

result
object