> 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/api-rest/identity-api/identity-api-reference/shared-biometric-components/facial-extraction.md).

# Extração facial

Serviço que realiza a **detecção e validação facial** a partir de uma imagem aberta ou tokenizada.

{% hint style="warning" %}
Observe que todos os valores retornados são estimativas baseadas na imagem facial fornecida. A precisão e a confiabilidade reais podem variar dependendo da qualidade e das características da imagem de entrada.
{% endhint %}

### Endpoint

```
POST /extractFacial
```

### Cabeçalhos

| Nome          | Tipo   | Obrigatório | Descrição                                                     |
| ------------- | ------ | ----------- | ------------------------------------------------------------- |
| **x-api-key** | string | **Sim**     | API Key de autorização de acesso.                             |
| **family**    | string | Não         | Valor: **OnBoarding**. Obrigatório com o serviço de tracking. |

{% hint style="info" %}
Todas as chamadas aos endpoints de tracking com **Identity Platform** devem conter o cabeçalho `family`.
{% endhint %}

### Corpo da solicitação

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

#### Parâmetros

| Parâmetro              | Tipo   | Obrigatório | Descrição                                                                                            |
| ---------------------- | ------ | ----------- | ---------------------------------------------------------------------------------------------------- |
| `tokenBuffer`          | string | **Sim**     | Imagem codificada em **Base64** ou **tokenizada** para detecção facial.                              |
| `tracking`             | object | Não         | Objeto que representa as informações de acompanhamento necessárias.                                  |
| `tracking.extraData`   | string | Não         | Token gerado pelo SDK Mobile/Web. Contém informações de acompanhamento tokenizadas com a Plataforma. |
| `tracking.operationId` | string | Não         | Identificador da operação gerado pelo SDK Mobile/Web.                                                |

#### Exemplo de solicitação

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

{% hint style="warning" %}
**Tamanho máximo da solicitação: 6 MB.** A imagem em Base64 ou tokenizada (`tokenBuffer`) e os demais campos contam para esse limite, com um acréscimo de \~33% em relação ao arquivo original (máximo de \~4,5 MB para o arquivo original). Recomenda-se usar imagens JPEG compactadas de no máximo 1–2 MB. Se o limite for excedido, o gateway responde `413` sem processar a solicitação. Consulte [Limite de tamanho da solicitação](https://docs.facephi.com/pages/1b12810f7c9abac00ee2fed384b12d3575d93434#l%C3%ADmite-de-tama%C3%B1o-de-la-solicitud).
{% endhint %}

### Respostas

#### `200` Sucesso

#### Parâmetros de resposta

| Parâmetro                       | Tipo    | Descrição                                                                                                                                                |
| ------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `serviceResultCode`             | inteiro | Código que indica o **resultado geral** da execução do serviço.                                                                                          |
| `serviceResultLog`              | string  | Campo descritivo do resultado ou da mensagem de erro, se aplicável.                                                                                      |
| `serviceTime`                   | string  | Tempo de processamento da solicitação **(milissegundos)**.                                                                                               |
| `serviceFacialExtractionResult` | string  | Objeto JSON que representa os resultados da **detecção e validação facial**. Consulte [Campos do resultado](#campos-del-resultado-de-extracción-facial). |
| `serviceTransactionId`          | string  | Identificador da transação associado à solicitação processada pela API.                                                                                  |

#### Campos do resultado da extração facial

| Campo            | Tipo    | Descrição                                                                                              |
| ---------------- | ------- | ------------------------------------------------------------------------------------------------------ |
| `faceConfidence` | float   | Indica o **nível de confiança** do rosto avaliado.                                                     |
| `age`            | inteiro | Indica a **possível idade** detectada.                                                                 |
| `glasses`        | string  | Indica a detecção de óculos. Valores possíveis: `Eye` (Óculos), `None` (Nenhum), `Sun` (Óculos de sol) |
| `gender`         | string  | Retorna o **gênero detectado**. Valores possíveis: `Male`, `Female`, `None` (Indeterminado)            |
| `iod`            | inteiro | Indica a **distância interpupilar**.                                                                   |

#### Código de resultado do serviço

O `serviceResultCode` indica o resultado geral da execução do serviço:

| serviceResultCode | Descrição                                                                              | Código HTTP |
| ----------------- | -------------------------------------------------------------------------------------- | ----------- |
| 0                 | A execução do serviço foi bem-sucedida; o módulo processou a solicitação corretamente. | 200         |

#### Exemplo de resposta

```json
{
  "serviceResultCode": 0,
  "serviceResultLog": "Service request successfully processed",
  "serviceTime": "864",
  "serviceFacialExtractionResult": "{\"faceConfidence\":0.9999948143959045,\"age\":30,\"glasses\":\"None\",\"gender\":\"Male\",\"iod\":154}",
  "serviceTransactionId": "b2f6297b-01ca-4aa3-afd7-6cb3c9d74141"
}
```

#### `400` Solicitação inválida

```json
{
  "status": 400,
  "title": "Solicitação inválida",
  "detail": "Solicitação inválida.",
  "type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400",
  "errors": []
}
```

#### `401` Não autorizado

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

#### `403` Proibido

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

#### `413` Payload muito grande

A solicitação excede o tamanho máximo permitido. O gateway a rejeita **sem processá-la**: a resposta não inclui `serviceResultCode` nem `serviceTransactionId`. Consulte [Limite de tamanho da solicitação](https://docs.facephi.com/pages/1b12810f7c9abac00ee2fed384b12d3575d93434#l%C3%ADmite-de-tama%C3%B1o-de-la-solicitud).

Solicitação maior que 6 MB e de até 10 MB (`Content-Type: application/json`):

```json
{
  "message": "Request Too Long"
}
```

Solicitação maior que 10 MB (10.485.760 bytes) (`Content-Type: text; charset=utf-8`, texto simples, não JSON):

```
HTTP content length exceeded 10485760 bytes.
```

#### `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` Timeout do gateway

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