Documentação da API finstat
A API do finstat transforma o PDF de um balanço patrimonial e de uma DRE em dados estruturados. A extração é automática; quando o resultado precisa de conferência, uma pessoa da equipe finstat revisa antes da liberação.
Como funciona
- Você envia o PDF bruto com o CNPJ, a data de encerramento e a entidade. A API responde
202com oiddo documento. - O documento passa pela extração automática e, quando necessário, por conferência humana. Integre de forma assíncrona: com conferência, a liberação pode levar algumas horas.
- Quando o resultado é liberado, o finstat envia um webhook
completed. Você busca o resultado emGET /v1/documents/{id}/result.
Cada linha do resultado traz a conta padronizada (termo_total), o valor como string decimal e a posição do número no PDF (página e caixa), para você mostrar a origem de cada valor.
Comece por aqui
- Início rápido: chave, primeiro envio e resultado em poucos minutos.
- Autenticação e chaves: escopos, troca e revogação.
- Webhooks: assinatura, deduplicação e novas tentativas.
- Referência da API: todas as rotas, com exemplos em curl, Node e Python.
O que a API oferece
| Rota | Para quê | Escopo |
|---|---|---|
POST /v1/documents | Enviar o PDF. | documents:write |
GET /v1/documents/{id} | Consultar a situação. | documents:read |
GET /v1/documents/{id}/result | Buscar o resultado liberado do documento. | documents:read |
GET /v1/history/{cnpj} | Juntar tudo o que foi liberado para um CNPJ. | documents:read |
A URL base é https://finstat.com.br. O contrato completo está em OpenAPI 3.1, também servido pela API em /v1/openapi.json. Para assistentes de IA, o guia inteiro em texto está em /v1/llms.txt.
Cobrança
É faturável a primeira liberação de cada documento, no mês em que ela ocorre. Envio, repetição idempotente, recusa, nova conferência e consultas não geram cobrança.
Dados de exemplo
Todos os exemplos desta documentação usam dados fictícios: CNPJ 00000000000191, empresa "Empresa Exemplo Ltda", ids como 00000000-0000-4000-8000-000000000001 e valores inventados. Nunca cole documentos ou chaves reais em tickets, logs ou assistentes.