> For the complete documentation index, see [llms.txt](https://docs.facephi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.facephi.com/api-rest/identity-api/identity-api-reference/shared-biometric-components/evaluate-passive-liveness-token.md).

# Evaluate Passive Liveness Token

Este servicio realiza una verificación de vida utilizando la **mejor imagen tokenizada** obtenida durante la captura del selfie del usuario. Para generar la imagen tokenizada, se utiliza la **función nativa del widget Selphi**, con el **parámetro bestImage** (imagen abierta) generado por el widget.

### Integración

Requiere la implementación del **widget Selphi Mobile** o del **widget Selphi Web**.

### Endpoint

```
POST /services/evaluatePassiveLivenessToken
```

### Headers

| Nombre        | Tipo   | Requerido | Descripción                                                   |
| ------------- | ------ | --------- | ------------------------------------------------------------- |
| **x-api-key** | string | **Sí**    | API key de autorización de acceso.                            |
| **family**    | string | No        | Valor: **OnBoarding**. Requerido con el servicio de tracking. |

{% hint style="info" %}
Todas las llamadas a los Endpoints para tracking con **Identity Platform** deben contener el header `family`.
{% endhint %}

### Cuerpo de la solicitud

**Content-Type:** `application/json`

#### Parámetros

| Parámetro              | Tipo   | Requerido | Descripción                                                                                                   |
| ---------------------- | ------ | --------- | ------------------------------------------------------------------------------------------------------------- |
| `imageBuffer`          | string | **Sí**    | Propiedad **BestImage** generada por el widget Selphi y **tokenizada** mediante la función nativa del widget. |
| `tracking`             | object | No        | Objeto que representa la información de seguimiento necesaria.                                                |
| `tracking.extraData`   | string | No        | Token generado por el SDK Mobile/Web. Contiene información de seguimiento tokenizada con la Plataforma.       |
| `tracking.operationId` | string | No        | Identificador de operación generado por el SDK Mobile/Web.                                                    |

#### Ejemplo de solicitud

```json
{
  "imageBuffer": "BAMBAQLNHJoWGPjfeuDIzDXdZuP...",
  "tracking": {
    "extraData": "BQABAQG2gBNjuHN4kLmPqYf7R...",
    "operationId": "123e4567-e89b-12d3-a456-426614174000"
  }
}
```

### Respuestas

#### `200` Éxito

#### Parámetros de respuesta

| Parámetro               | Tipo    | Descripción                                                                                                              |
| ----------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------ |
| `serviceResultCode`     | integer | Código que indica el **resultado general** de la ejecución del servicio. Ver [Service Result Code](#service-result-code) |
| `serviceResultLog`      | string  | Campo descriptivo del resultado de la ejecución del servicio. Incluye detalles cuando hay un error o excepción.          |
| `serviceTime`           | string  | Tiempo total de respuesta **(milisegundos)**.                                                                            |
| `serviceTransactionId`  | string  | Identificador de transacción asociado a la solicitud procesada por la API.                                               |
| `serviceLivenessResult` | integer | Código que indica el **resultado de la prueba de vida pasiva**. Ver [Service Liveness Result](#service-liveness-result)  |

#### Service Result Code

El `serviceResultCode` indica el resultado general de la ejecución del servicio:

| serviceResultCode | Descripción                                                                          | Código HTTP |
| ----------------- | ------------------------------------------------------------------------------------ | ----------- |
| 0                 | La ejecución del servicio fue exitosa, el módulo procesó la solicitud correctamente. | 200         |

#### Service Liveness Result

El `serviceLivenessResult` indica el resultado de la evaluación de la prueba de vida pasiva:

| Código | Resultado                       | Descripción                                                                                       |
| ------ | ------------------------------- | ------------------------------------------------------------------------------------------------- |
| 0      | None                            | No se pudo evaluar la prueba de vida.                                                             |
| 1      | Spoof                           | DEPRECADO. Usar 'NoLive' en su lugar.                                                             |
| 2      | Uncertain                       | DEPRECADO                                                                                         |
| 3      | Live                            | Se asume que el sujeto está vivo.                                                                 |
| 4      | NoneBecauseBadQuality           | No se pudo evaluar la prueba de vida debido a la mala calidad de la imagen.                       |
| 5      | NoneBecauseFaceTooClose         | No se pudo evaluar la prueba de vida porque los rostros detectados están muy cerca de los bordes. |
| 6      | NoneBecauseFaceNotFound         | No se pudo evaluar la prueba de vida porque no se detectaron rostros.                             |
| 7      | NoneBecauseFaceTooSmall         | No se pudo evaluar la prueba de vida porque los rostros detectados son muy pequeños.              |
| 8      | NoneBecauseAngleTooLarge        | No se pudo evaluar la prueba de vida porque el ángulo entre rostros excede el límite permitido.   |
| 9      | NoneBecauseImageDataError       | No se pudo evaluar la prueba de vida debido a errores en el formato de la imagen.                 |
| 10     | NoneBecauseInternalError        | No se pudo evaluar la prueba de vida debido a un error interno.                                   |
| 11     | NoneBecauseImagePreprocessError | No se pudo evaluar la prueba de vida debido a un error en el preprocesamiento de la imagen.       |
| 12     | NoneBecauseTooManyFaces         | No se pudo evaluar la prueba de vida porque se detectaron demasiados rostros en la imagen.        |
| 13     | NoneBecauseFaceTooCloseToBorder | No se pudo evaluar la prueba de vida porque el rostro está muy cerca del borde.                   |
| 14     | NoneBecauseFaceCropped          | No se pudo evaluar la prueba de vida porque el rostro está recortado.                             |
| 15     | NoneBecauseLicenseError         | No se pudo evaluar la prueba de vida debido a un error de licencia.                               |
| 16     | NoneBecauseFaceOccluded         | No se pudo evaluar la prueba de vida porque el rostro está ocluido.                               |
| 17     | NoLive                          | No se detectó vida.                                                                               |
| 18     | NoneBecauseEyesClosed           | No se pudo evaluar la prueba de vida porque los ojos de la persona están cerrados.                |

#### Ejemplo de respuesta: Live

```json
{
  "serviceResultCode": 0,
  "serviceResultLog": "Live",
  "serviceTime": "799",
  "serviceTransactionId": "35d93da8-b843-4033-8e78-c0aabedcef8b",
  "serviceLivenessResult": 3
}
```

#### Ejemplo de respuesta: NoLive

```json
{
  "serviceResultCode": 0,
  "serviceResultLog": "NoLive",
  "serviceTime": "81",
  "serviceTransactionId": "3f332c81-3dfa-4952-b593-20e3b5651b5b",
  "serviceLivenessResult": 0
}
```

#### `400` Bad Request

```json
{
  "status": 400,
  "title": "Bad Request",
  "detail": "Invalid request.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400",
  "errors": []
}
```

#### `401` Unauthorized

```json
{
  "message": "Unauthorized"
}
```

#### `403` Forbidden

```json
{
  "Message": "User is not authorized to access this resource with an explicit deny"
}
```

#### `502` Bad Gateway

```json
{
  "status": 502,
  "title": "Bad Gateway",
  "detail": "Server got an invalid response.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502"
}
```

#### `504` Gateway Timeout

```json
{
  "message": "Endpoint request timed out"
}
```
