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

# Convenções

> Formato dos dados, datas, paginação, idempotência e mascaramento

## Formato

Requisições com corpo e respostas usam JSON (`Content-Type: application/json`). As duas APIs são servidas em `https://api.nlbs.ai`, sem prefixo de caminho.

## Datas

* API de Dados: data de calendário em `AAAA-MM-DD` e instante em ISO 8601 UTC terminando em `Z` (por exemplo, `2026-01-15T12:00:00Z`).
* API de Anti Fraude: o formato de cada campo de data está descrito na referência da rota.

## Paginação

As respostas são resumidas e paginadas, nunca um resultado gigante de uma vez.

* API de Dados: cursor opaco. Repita a chamada com o `proximo_cursor` recebido até ele vir `null`. O cursor é emitido pela API: não monte nem altere. `limite` vai de 1 a 100.
* API de Anti Fraude: as listagens usam `limit` e `offset` ou `cursor`, conforme a rota. Veja a referência de cada uma.

## Idempotência

`POST /dados/consultar` e `GET /dados/processos/{numero}` aceitam o cabeçalho opcional `Idempotency-Key`. A mesma chave, em 24 horas a partir da primeira chamada, devolve a mesma resposta sem repetir a leitura.

## Mascaramento de documentos

CPF e CNPJ de terceiros vêm mascarados nas respostas, e o nome vem inteiro. Em `GET /entities` (API de Anti Fraude), os identificadores vêm sempre mascarados. Na API de Dados, o documento da entidade consultada não é mascarado. Veja o detalhe em [API de Dados](https://docs.nlbs.ai/dados/introducao.md#mascaramento-de-documentos-de-terceiros).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.