Saltar al contenido principal
POST
/
document
ID Liveness Detection
curl --request POST \
  --url https://idverify-api.argosidentity.com/modules/document \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "idImage": "base64_encoded_id_document_image",
  "pipelines": {
    "sr": true,
    "pc": true,
    "ps": true
  },
  "useUpcomingVersion": true,
  "callbackUrl": "https://your-domain.com/callback"
}
'
{
  "apiType": "id_live_doc",
  "transactionId": "txn_123456789",
  "engineVersion": "id_liveness@3.4.2",
  "result": {
    "screenReplay": {
      "liveness_score": 99
    },
    "paperPrinted": {
      "liveness_score": 82
    },
    "replacePortraits": {
      "liveness_score": 100
    }
  }
}
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:

​
Atributos de respuesta

​
transactionId
string
Identificador único de la transacción asociada con la solicitud de reconocimiento.
​
result
string
Devuelve las puntuaciones de detección para cada pipeline.Valores de pipelines:
  • screenReplay - liveness_score
  • paperPrinted - liveness_score
  • replacePortraits - liveness_score
​
errorCode
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
​
message
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
file
requerido

Base64 encoded ID document image to analyze for liveness detection. 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