powered by Nortcash
Testar grátis
documentação

Documentação

Do cadastro à primeira consulta, pela API ou pelo MCP. Tudo é somente leitura: não existe pagamento, Pix ou transferência.

Comece em quatro passos

  1. Crie a conta só com o e-mail em https://app.openfinancemcp.ai/cadastro. O acesso chega por um link no e-mail, sem senha.
  2. Informe o primeiro CNPJ ou CPF e autorize os bancos. A autorização acontece no site ou app de cada banco, pelo Open Finance. Se outra pessoa acessa o banco, envie o link de autorização para ela.
  3. Copie a chave de API na tela “Tudo pronto” ou em Chaves de API. Ela aparece inteira uma vez só.
  4. Faça a primeira consulta, pela API ou pelo MCP.

O teste de 30 dias começa quando o primeiro banco for autorizado, vale para até 20 CNPJs e não pede cartão.

Primeira consulta pela API

Toda chamada leva a chave no cabeçalho Authorization e o CNPJ ou CPF no cabeçalho x-company-register (com ou sem máscara).

curl "https://api.openfinancemcp.ai/v1/transactions?limit=5" \
  -H "Authorization: Bearer SUA_CHAVE" \
  -H "x-company-register: 00000000000100"

As listas vêm paginadas: data traz os itens e pagination traz count, page, limit, last, prev e next. Use page (a partir de 1) e limit (até 100).

Usar com IA, pelo MCP

A mesma URL serve para qualquer assistente:

https://mcp.openfinancemcp.ai/mcp

Claude

Abra o Claude, adicione um conector personalizado com o nome Open Finance MCP e cole a URL. O Claude abre a nossa página: informe o e-mail da conta e clique no link que chegar.

Cursor

Cole em ~/.cursor/mcp.json:

{
  "mcpServers": {
    "open-finance-mcp": { "url": "https://mcp.openfinancemcp.ai/mcp" }
  }
}

Claude Code

claude mcp add --transport http open-finance-mcp https://mcp.openfinancemcp.ai/mcp

Em script ou servidor, sem navegador, passe a chave de API:

claude mcp add --transport http open-finance-mcp https://mcp.openfinancemcp.ai/mcp \
  --header "Authorization: Bearer SUA_CHAVE"

ChatGPT

Com o modo de desenvolvedor ligado em Configurações avançadas, crie um app com o nome Open Finance MCP, cole a URL em MCP Server URL e escolha OAuth em Authentication. O passo a passo também está na página inicial.

Chaves de API

Cada chave lê todos os CNPJs e CPFs da conta. Guarde no servidor da sua plataforma, nunca no navegador. A conta tem até 5 chaves ativas; rotacionar troca a chave na hora e revogar corta o acesso sem volta.

O que dá para consultar

RotaO que devolve
GET /v1/accountsContas do CNPJ ou CPF, com saldo e limite do cartão.
GET /v1/balanceSaldo consolidado. Com x-company-register: all, de todos os CNPJs e CPFs.
GET /v1/balance-historyEvolução do saldo de cada conta, por período.
GET /v1/transactionsTransações, com filtro por período, conta, conexão, tipo, descrição e valor.
GET /v1/card-billsFaturas de cartão.
GET /v1/investmentsInvestimentos.
GET /v1/loansEmpréstimos.
GET /v1/holder-profileDados cadastrais da empresa (atividade, sócios) ou da pessoa.

Saída é sempre negativa e entrada é sempre positiva, em conta e em cartão. O que o banco não informa vem vazio.

Erros

Todo erro responde com o status HTTP e um corpo { "message": "...", "code": "..." }, com a mensagem em português.

Status e códigoQuando
402 subscription_requiredO teste terminou e o CNPJ ou CPF ainda não está na assinatura.
403 holder_not_foundO CNPJ ou CPF do cabeçalho não está na conta.
401Chave ausente, revogada ou inválida.

Conectar os bancos dos seus usuários

Há dois caminhos. O conector é um link pronto para um botão da sua plataforma. A API de conexão é para quem quer montar a própria tela.