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

# Guia de referência da API

## 1. Introdução

Este documento inclui a descrição da API do serviço fornecido no produto **Serviço FacePhi INE**.

## 2. API Rest

A autenticação JWT é opcional e é configurada somente na inicialização. Quando está habilitada, `GET /api/v1/health` e `GET /api/v1/version` permanecem públicos, enquanto `POST /api/v1/facial/authentication` requer um JWT válido.

O serviço oferece os seguintes endpoints:

* **/api/v1/facial/authentication**: Este endpoint é usado para autenticar duas fotos faciais. Suporta combinações imagem-imagem, template-template e combinações mistas imagem-template. Retorna um valor de pontuação que indica se o rosto pertence à mesma pessoa e uma probabilidade que indica a semelhança entre os dois rostos. A imagem ou template deve estar codificada em base64.
* **/api/v1/health**: Este endpoint retorna o status de saúde do serviço e permanece público mesmo quando a autenticação JWT está habilitada.
* **/api/v1/version**: Este endpoint retorna a versão do serviço e as informações do SDK.

O serviço não expõe endpoints `GET/POST /config` em tempo de execução.

## 3. Tipos de foto

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

## 4. Códigos de erro

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

Os payloads com JSON ou Base64 malformados são retornados como HTTP `400 BadRequest` com um campo `message` que descreve o problema.