Endpoint
Autenticação
| Header | Obrigatório | Valor |
|---|---|---|
X-API-Key | Sim | Sua chave de API (bun_...) |
Content-Type | Sim | application/json |
Visão geral
Gere lotes de números de CPF (Cadastro de Pessoas Físicas) ou CNPJ (Cadastro Nacional da Pessoa Jurídica) matematicamente válidos para uso em ambientes de teste. Todos os documentos gerados passam pelo algoritmo oficial de verificação e podem ser retornados opcionalmente com máscaras de formatação padrão. São números sintéticos apenas para fins de teste e não correspondem a pessoas físicas ou jurídicas reais.Casos de uso
- Popular bancos de dados de teste e ambientes de QA com documentos brasileiros realistas
- Validar componentes de formulários em pipelines de CI sem usar dados reais
- Demonstrar comportamento de validação de formulários em demos ao vivo e protótipos
- Gerar fixtures para testes unitários e de integração
Corpo da requisição
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
type | string | Não | Tipo de documento: "cpf" ou "cnpj". Padrão: "cpf" |
count | integer | Não | Número de documentos a gerar (1–100). Padrão: 1 |
formatted | boolean | Não | Retornar strings formatadas (ex: "123.456.789-09"). Padrão: true |
Exemplo
Resposta
200 OK
| Campo | Tipo | Descrição |
|---|---|---|
type | string | Tipo de documento retornado |
count | integer | Número de documentos gerados |
documents | array de objetos | Cada entrada contém raw (sem formatação) e formatted (se solicitado) |
document | string | Primeiro documento do lote (atalho para casos com count: 1) |

