> 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.md).

# Identity API reference

Este documento incluye la especificación de los servicios expuestos en modo SaaS a través de las APIs REST de Facephi para los productos Onboarding y Authentication.

#### Acceso a la API

| Parámetro | Valor                              |
| --------- | ---------------------------------- |
| Host      | <https://api.identity-platform.io> |

#### Autorizaciones

Todas las llamadas a los Endpoints deben incluir las siguientes claves en el encabezado de la solicitud:

| Clave       | Valor                             | Requerido |
| ----------- | --------------------------------- | --------- |
| `x-api-key` | API key de autorización de acceso | **Sí**    |

Si las claves requeridas mencionadas anteriormente no se incluyen o no son válidas, la solicitud es rechazada por el **gateway antes de llegar al servicio**. Estas respuestas son las respuestas por defecto de AWS API Gateway y **no** usan el sobre `serviceResultCode`:

| Código HTTP | Cuerpo de la respuesta                                                                | Caso                                       |
| ----------- | ------------------------------------------------------------------------------------- | ------------------------------------------ |
| 401         | `{"message": "Unauthorized"}`                                                         | API key ausente o inválida.                |
| 403         | `{"Message": "User is not authorized to access this resource with an explicit deny"}` | API key válida pero sin acceso al recurso. |

{% hint style="info" %}
La capitalización del campo difiere entre ambas respuestas (`message` en el `401`, `Message` en el `403`): son los cuerpos por defecto de AWS API Gateway.
{% endhint %}

#### Integración con Identity Platform

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

| Clave    | Valor                                                                                                                                                                              |
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `family` | **OnBoarding** — Para todas las llamadas relacionadas con procesos de Onboarding Digital. **Authentication** — Para todas las llamadas relacionadas con procesos de Autenticación. |

#### Tiempo de respuesta de los servicios

| Proceso             | Tiempo estimado / promedio                                       | Notas                                                                               |
| ------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| Prueba de vida      | Procesamiento < 1 segundo + Latencia de red entre 2 y 4 segundos | El tiempo total percibido depende del salto de red.                                 |
| Coincidencia facial | Procesamiento < 1 segundo + Latencia de red entre 2 y 4 segundos | Similar a la prueba de vida, depende de la conectividad.                            |
| Registro civil      | Típicamente < 10 segundos                                        | El registro no se compromete a un SLA formal de tiempo de respuesta.                |
| Morfología          | Promedio: 60 segundos. Máximo: 270 segundos                      | Proceso semi-automatizado; varía según la carga y las condiciones de procesamiento. |