> ## Documentation Index
> Fetch the complete documentation index at: https://docs.deepxl.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Análise de Documentos

> Extraia e analise dados estruturados de IDs e documentos

O Modelo de Análise extrai e analisa dados estruturados de IDs e documentos — nomes, datas, endereços, valores e muito mais.

## Modelos Disponíveis

| Modelo        | Caso de uso                                                                                                                                                                                               | Tipos de arquivo compatíveis |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
| `light`       | Modelo leve de análise. A extração de dados é voltada para Carteira de Motorista, Documento de Identidade estadual, Permissão de Residência, Cartão de Seguro Social, Identidade Militar                  | jpg, jpeg, png, webp, pdf    |
| `performance` | Modelo de análise de alto desempenho. A extração de dados é voltada para extratos bancários, contracheques dos EUA e documentos de identidade emitidos pelo governo (por exemplo, carteiras de motorista) | jpg, jpeg, png, webp, pdf    |

Recupere a lista completa de modelos programaticamente:

```bash theme={null}
curl https://api.deepxl.ai/v1/parsing-models \
  -H "x-api-key: YOUR_API_KEY"
```

## Analisando um Documento

Envie um arquivo para análise via `POST /v1/parse`:

```bash theme={null}
curl -X POST https://api.deepxl.ai/v1/parse \
  -H "x-api-key: YOUR_API_KEY" \
  -F "model=light" \
  -F "file=@drivers_license.jpg" \
  -F 'tags={"customerId":"9999","customerName":"Acme Corp","documentId":"DOC-001","companyName":"DeepXL","companyId":"COMP-001"}'
```

### Parâmetros

| Parâmetro | Tipo   | Obrigatório | Descrição                                                                                                                |
| --------- | ------ | ----------- | ------------------------------------------------------------------------------------------------------------------------ |
| `model`   | string | Sim         | `light` ou `performance`                                                                                                 |
| `file`    | file   | Sim         | O documento a ser analisado (máx. 50MB)                                                                                  |
| `tags`    | string | Não         | Objeto JSON com pares chave-valor de metadados                                                                           |
| `country` | string | Não         | Dica opcional de país. Valores suportados: `us`, `mx`, `br`. Valores ausentes, vazios ou inválidos usam `us` por padrão. |

### Comportamento da Dica de País

Use o parâmetro opcional `country` quando quiser direcionar a análise para um mercado específico compatível.

* Valores suportados: `us`, `mx`, `br`
* A correspondência não diferencia maiúsculas de minúsculas
* Espaços em branco no início e no fim são ignorados
* Valores ausentes, vazios ou inválidos usam `us` como padrão

O valor da solicitação é tratado como uma **dica de roteamento**. Ele é normalizado antes de a solicitação ser encaminhada downstream, e o valor normalizado é retornado como `country` nos metadados da resposta de análise.

Exemplo:

```bash theme={null}
curl -X POST https://api.deepxl.ai/v1/parse \
  -H "x-api-key: YOUR_API_KEY" \
  -F "model=performance" \
  -F "file=@bank_statement.pdf" \
  -F "country=br" \
  -F 'tags={"customerId":"9999","customerName":"Acme Corp","documentId":"DOC-2024-042","companyName":"DeepXL","companyId":"COMP-001"}'
```

## Estrutura da Resposta

```json theme={null}
{
  "result": {
    "parseId": 123,
    "mediaType": "image",
    "fileType": "jpeg",
    "fileName": "drivers_license.jpg",
    "fileSize": 231433,
    "timestamp": 1770984134,
    "timestampISO": "2026-02-13T13:02:14.833162",
    "model": "light",
    "modelVersion": "1.2.0",
    "documentType": "idDocument",
    "parsedData": {
      "firstName": "JOHN",
      "lastName": "DOE",
      "dateOfBirth": "1990-05-15",
      "licenseNumber": "D1234567",
      "expirationDate": "2028-05-15",
      "address": "123 MAIN ST ANYTOWN, CA 90210"
    },
    "tags": [
      { "name": "customerId", "value": "9999" },
      { "name": "customerName", "value": "Acme Corp" },
      { "name": "documentId", "value": "DOC-001" },
      { "name": "companyName", "value": "DeepXL" },
      { "name": "companyId", "value": "COMP-001" }
    ],
    "files": [
      {
        "category": "original_file",
        "fileName": "drivers_license.jpg",
        "fileSize": 231433,
        "contentType": "image/jpeg",
        "timestamp": 1770984134,
        "timestampISO": "2026-02-13T13:02:14.833162",
        "url": "https://api.deepxl.ai/v1/files/parse_123_drivers_license.jpg"
      }
    ]
  }
}
```

### Referência dos Campos

| Campo          | Tipo      | Descrição                                                                            |
| -------------- | --------- | ------------------------------------------------------------------------------------ |
| `parseId`      | integer   | Identificador único do registro de análise                                           |
| `mediaType`    | string    | Categoria do tipo de mídia (`image` ou `document`)                                   |
| `fileType`     | string    | Extensão do arquivo (`jpeg`, `png`, `pdf`, `webp`)                                   |
| `fileName`     | string    | Nome original do arquivo enviado                                                     |
| `fileSize`     | integer   | Tamanho do arquivo em bytes                                                          |
| `timestamp`    | integer   | Timestamp Unix da análise                                                            |
| `timestampISO` | string    | Timestamp ISO 8601 da análise                                                        |
| `model`        | string    | Modelo usado (`light` ou `performance`)                                              |
| `modelVersion` | string    | Versão do modelo usada na análise                                                    |
| `documentType` | string    | Tipo de documento identificado (ex.: `idDocument`, `bankStatement.us`, `payStub.us`) |
| `parsedData`   | object    | Pares chave-valor extraídos (os campos variam conforme o tipo de documento)          |
| `tags`         | object\[] | Tags de metadados anexadas a esta análise                                            |
| `files`        | object\[] | Arquivos associados (upload original)                                                |

## Entendendo os Resultados

### Tipo de Documento

O campo `documentType` identifica o tipo de documento analisado (por exemplo, `idDocument`, `bankStatement.us` ou `payStub.us`).

### Dados Analisados

O objeto `parsedData` contém os pares chave-valor extraídos. Os campos dependem do tipo de documento.

**Documentos de identificação (modelo leve):**

| Campo            | Descrição                                  |
| ---------------- | ------------------------------------------ |
| `firstName`      | Nome                                       |
| `lastName`       | Sobrenome                                  |
| `dateOfBirth`    | Data de nascimento (AAAA-MM-DD)            |
| `licenseNumber`  | Número da carteira ou do documento         |
| `expirationDate` | Data de validade do documento (AAAA-MM-DD) |
| `address`        | Endereço completo                          |

**Tipos de documento do modelo `performance`:**

Os campos extraídos variam conforme o tipo de documento. O conjunto atual é `idDocument`, `bankStatement.us` e `payStub.us`.

## Tags e Filtragem

Anexe metadados para organizar seus resultados de análise:

```bash theme={null}
curl -X POST https://api.deepxl.ai/v1/parse \
  -H "x-api-key: YOUR_API_KEY" \
  -F "model=performance" \
  -F "file=@bank_statement.pdf" \
  -F 'tags={"customerId":"9999","customerName":"Acme Corp","documentId":"DOC-2024-042","companyName":"DeepXL","companyId":"COMP-001"}'
```

Filtre seu histórico de análises:

```bash theme={null}
curl "https://api.deepxl.ai/v1/parse?tagFilter=customerId=9999" \
  -H "x-api-key: YOUR_API_KEY"
```

## Navegando pelo Histórico

Recupere resultados de análise paginados:

```bash theme={null}
curl "https://api.deepxl.ai/v1/parse?limit=25&offset=0&sortBy=parseId&direction=desc" \
  -H "x-api-key: YOUR_API_KEY"
```

### Opções de Ordenação

`parseId`, `mediaType`, `fileType`, `fileName`, `fileSize`, `confidence`, `documentType`, `timestamp`
