> 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/sdks/backend-sdk/ine/technical_documentation/api_reference.md).

# Guía de referencia de la API

## 1. Introducción

Este documento incluye la descripción de la API del servicio proporcionado en el producto **FacePhi INE Service**.

## 2. API REST

La autenticación JWT es opcional y se configura únicamente al arrancar. Cuando está habilitada, `GET /api/v1/health` y `GET /api/v1/version` permanecen públicos, mientras que `POST /api/v1/facial/authentication` requiere un JWT válido.

El servicio ofrece los siguientes endpoints:

* **/api/v1/facial/authentication**: Este endpoint se utiliza para autenticar dos fotos faciales. Soporta combinaciones de imagen-imagen, plantilla-plantilla y combinaciones mixtas de imagen-plantilla. Devuelve un valor de puntuación que indica si el rostro pertenece a la misma persona, y una probabilidad que indica la similitud entre los dos rostros. La imagen o plantilla debe estar codificada en base64.
* **/api/v1/health**: Este endpoint devuelve el estado de salud del servicio y permanece público incluso cuando la autenticación JWT está habilitada.
* **/api/v1/version**: Este endpoint devuelve la versión del servicio y la información del SDK.

El servicio no expone endpoints `GET/POST /config` en tiempo de ejecución.

## 3. Tipos de foto

```cpp
    INE              = 0
    JPEG             = 1
    TEMPLATE_RAW     = 2
    BEST_IMAGE_TOKEN = 3
```

## 4. Códigos de error

```cpp
	OK              = 0
    MALFORMED_JSON  = 400
    PHOTOA_EMPTY    = 401
    PHOTOB_EMPTY    = 402
    NO_PHOTOS       = 403
    POSE_INVALID    = 404
    PHOTOA_INVALID  = 405
    PHOTOB_INVALID  = 406
```

Los payloads con JSON o Base64 mal formados se devuelven como HTTP `400 BadRequest` con un campo `message` que describe el problema.