Saltar al contenido principal
POST
/
liveness
Detect liveness in facial image
curl --request POST \
  --url https://idverify-api.argosidentity.com/modules/liveness \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "faceImage": "{{faceImage_base64}}"
}
'
{
  "apiType": "id_live_face",
  "result": {
    "liveness_score": 95
  },
  "transactionId": "e0nvom3caiis7"
}
​
faceImage
string
requerido
Imagen facial en formato base64. Los caracteres codificados en Base64 en el payload no deben incluir el tipo MIME. Por ejemplo, si los caracteres codificados en base64 son “image/png;base64,/9j/2wBDABQODxIP…”, entonces elimine “image/png;base64,” y envíe solo los datos codificados “/9j/2wBDABQODxIP…”.
​
apiType
string
Identificador del tipo de API para el servicio de detección de liveness.
​
result.liveness_score
number
Puntuación de liveness que indica la probabilidad de una persona real (0-100). Puntuaciones más altas indican mayor confianza de que la imagen proviene de una persona real.
​
transactionId
string
Identificador único para cada solicitud, útil para fines de seguimiento y depuración.
​
message
string
Mensaje informativo devuelto como parte de la respuesta de reconocimiento, proporcionando contexto adicional sobre el resultado.
​
errorCode
number
Identifica el error específico para resolución de problemas. Los códigos de error comunes incluyen:
  • 1016: faceImage is required
  • 1017: Fail to analyze face

Autorizaciones

​
x-api-key
string
header
requerido

API key essential for authentication and access control purposes, required for authorization.

Cuerpo

application/json
​
faceImage
string
requerido

Face image in base64 format. Base64 encoded characters in the payload must not include the MIME type. For example, if the encoded base64 characters are "image/png;base64,/9j/2wBDABQODxIP...", then remove "image/png;base64," and send only the encoded data "/9j/2wBDABQODxIP...".

Ejemplo:

"{{faceImage_base64}}"

Respuesta

Everything worked as expected.

​
apiType
string

API type

Ejemplo:

"id_live_face"

​
result
object
​
transactionId
string

Unique identifier for each request

Ejemplo:

"e0nvom3caiis7"