API

API de extrato bancário: converter PDF em OFX, CSV e Excel

Atualizado em novembro de 2026

O que faz a API de extrato do pdfvera?

A API do pdfvera converte um extrato bancário em PDF em OFX, CSV e Excel por uma chamada HTTP. Antes de entregar, ela soma os lançamentos e confere com os saldos impressos no extrato; se a conta não fecha, nenhum arquivo é entregue nem contado. O acesso está incluído em toda assinatura e usa a mesma cota mensal do conversor no site.

O que a API entrega

Você envia o PDF do extrato; a API lê os lançamentos e confere o saldo. Quando a conta fecha, a resposta traz os arquivos em Base64, no campo outputs:

Arquivos em outputs (resposta de POST /api/v1/br/convert)
ArquivoConteúdo
.ofxOFX no formato do sistema contábil escolhido em profile
.csvlançamentos em CSV
.xlsxlançamentos em Excel, com a conferência do saldo

O nome de cada arquivo traz o banco; o do OFX traz também a conta e o período. Com o perfil dominio, um extrato de mais de 12 meses vem dividido em vários OFX de até 12 meses. Se o PDF tem mais de uma conta, vêm arquivos para cada conta. São os mesmos arquivos do conversor no site, com a mesma conferência.

Acesso e preço

  • A chave da API é criada na sua conta. Ela aparece uma vez só; o pdfvera guarda só um hash dela e os 10 primeiros caracteres.
  • A API faz parte de qualquer assinatura, sem custo extra. Cada extrato convertido conta uma vez na cota mensal, como no site.
  • Converter de novo o mesmo PDF no mesmo mês não conta outra vez.
  • A conferência sem arquivos (campo mode=preview, ou seja, -F mode=preview) não conta. Use para testar a integração sem gastar a cota.
  • Até cinco chaves por conta, por exemplo uma por sistema. Para bloquear uma chave, basta um clique na conta.

Os preços estão na página de preços. Para escritórios contábeis com muitos clientes há o plano “Escritório”, sob consulta.

Primeira chamada com curl

A chave vai no cabeçalho Authorization e o PDF no campo pdf:

curl https://pdfvera.com/api/v1/br/convert \
  -H "Authorization: Bearer pv_SUA_CHAVE" \
  -F pdf=@extrato.pdf \
  -F profile=dominio

Quando a conta fecha, a resposta traz "ok": true e os arquivos em outputs. Para salvar todos de uma vez com jq:

curl -s https://pdfvera.com/api/v1/br/convert \
  -H "Authorization: Bearer pv_SUA_CHAVE" \
  -F pdf=@extrato.pdf > resposta.json
jq -r '.outputs // {} | keys[]' resposta.json | while read f; do
  jq -r --arg f "$f" '.outputs[$f]' resposta.json | base64 --decode > "$f"
done

Campos do pedido

Campos multipart de POST /api/v1/br/convert
CampoObrigatórioUso
pdfsimo extrato em PDF, até 20 MB
profilenãosistema do OFX: dominio (padrão), alterdata, contaazul ou omie
passwordnãosenha do PDF, se o banco protegeu o arquivo
cpfnãoCPF do titular, para tentar as senhas comuns dos bancos
modenãopreview: só confere, sem arquivos e sem contar na cota

A resposta

Campos da resposta (JSON)
CampoSignificado
oktrue quando a conta fechou; os arquivos só vêm sem mode=preview
bankbanco reconhecido
reconciliationsaldo inicial, saldo final, saldo calculado e linhas conferidas
transactionsnúmero de lançamentos
accountsuma entrada por conta, se o PDF tiver mais de uma
causemotivo quando ok é false, por exemplo password se falta a senha
outputsnome do arquivo → conteúdo (Base64)
used, quotaextratos usados e incluídos no mês (quando há arquivos)

A cota do mês pode ser consultada em GET /api/v1/usage. A descrição completa de todos os campos está no arquivo OpenAPI.

Códigos de erro

Status HTTP e código error
StatuserrorSignificado
400profileprofile diferente de dominio, alterdata, contaazul ou omie
401keychave ausente, errada ou bloqueada
402subscriptionnenhuma assinatura ativa
402quotacota do mês esgotada; used e quota vêm na resposta
413sizePDF maior que 20 MB
415typeo arquivo não é PDF
422pagesmais de 300 páginas
422scannedmais de 40 páginas escaneadas
422pagesizepágina grande demais
429ratechamadas demais; scope diz minute, hour ou day
503busyconversão ocupada; tente de novo mais tarde
503unavailableconversão fora do ar por um tempo
500, 502, 504faileda conversão falhou; tente de novo mais tarde

Limites

  • Um PDF de até 20 MB e 300 páginas por chamada, com no máximo 40 páginas escaneadas.
  • Por conta, até 20 chamadas por minuto, 120 por hora e 1.000 por dia, somando site e API.
  • Um extrato por chamada. Para vários, chame a API um após o outro.

Servidor MCP para Claude, Cursor e outros assistentes de IA

Com o servidor MCP do pdfvera, um assistente de IA converte extratos no seu computador. O pequeno programa lê o PDF do seu disco, chama a API com a sua chave e salva os arquivos ao lado do PDF. Se o PDF tem senha, o assistente pergunta e tenta de novo. Valem a mesma cota e os mesmos limites da API.

claude mcp add pdfvera -e PDFVERA_API_KEY=pv_SUA_CHAVE -- npx -y pdfvera-mcp@latest

Ou como plugin pdfvera (/plugin marketplace add pdfvera/pdfvera-mcp, depois /plugin install pdfvera@pdfvera): ele não traz servidor MCP, mas mostra ao Claude como chamar a API diretamente. A chave vem de PDFVERA_API_KEY, definida em ~/.claude/settings.json em env.

Cursor e outros programas com suporte a MCP recebem o servidor na configuração MCP; no Cursor, em ~/.cursor/mcp.json:

{
  "mcpServers": {
    "pdfvera": {
      "command": "npx",
      "args": ["-y", "pdfvera-mcp@latest"],
      "env": { "PDFVERA_API_KEY": "pv_SUA_CHAVE" }
    }
  }
}

O servidor oferece três ferramentas: convert_bank_statement (extrato em PDF para OFX, CSV e Excel), convert_invoice (faturas alemãs) e get_usage (plano e cota). Para o ChatGPT, que só conecta servidores MCP na internet, ainda não há versão. Com @latest, o servidor busca as versões novas sozinho no próximo início. O código-fonte está no GitHub (licença MIT) e o pacote no npm.

Privacidade

O pdfvera não guarda o PDF enviado pela API, nem quando a conversão falha. Fica guardado só um hash do PDF quando há arquivos gerados, para o mesmo extrato não contar duas vezes no mês. Quando nossas regras não conseguem ler um extrato, o PDF é enviado à API da Anthropic só para ler os lançamentos; a Anthropic apaga esses dados em até 30 dias e não os usa para treinar modelos. Os detalhes estão na política de privacidade.

Perguntas sobre a API

A API custa à parte?

Não. Ela vem com qualquer assinatura e usa a mesma cota mensal das conversões no site.

Posso testar sem assinatura?

Com uma chave e mode=preview você confere extratos sem gastar cota. Os arquivos só vêm com uma assinatura.

Quais sistemas contábeis o OFX atende?

O campo profile aceita dominio, alterdata, contaazul e omie. Sem o campo, vale dominio.

E se o PDF tiver senha?

A resposta traz cause password. Envie de novo com o campo password, ou com cpf para tentar as senhas comuns dos bancos.

O extrato fica guardado?

O pdfvera não guarda o PDF enviado pela API, nem quando a conversão falha; fica só um hash do PDF quando há arquivos gerados. Extratos que nossas regras não leem passam pela API da Anthropic, que apaga os dados em até 30 dias.

Ferramentas relacionadas

Quer testar à mão antes?

No site, a conversão passa pela mesma conferência do saldo. A conferência é grátis e não pede cadastro.

Converter PDF em OFX