Voltar para Documentação

Open Finance API

Análise financeira via Open Finance — Renda, Capacidade Financeira, Expenses e Score.

Endpoint Base

POST /api/client/provider/open-finance

Produtos Disponíveis

0

Autenticação

Bearer JWT

Produtos Disponíveis

Nenhum produto disponível no momento.

Como Usar

Todas as consultas são feitas em um único endpoint. Informe os produtos desejados no array product_code. O resultado é retornado agrupado por produto.

Validação all-or-nothing: Todos os produtos informados devem estar contratados. Se qualquer produto não estiver disponível, a requisição inteira é rejeitada antes de qualquer consulta ser feita.

Exemplo cURL

curl -X POST \
  https://positivaconnect.positivaconsultas.com.br/api/client/provider/open-finance \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "12345678901",
    "product_code": []
  }'

Formato da Resposta

{
  "success": true,
  "document": "12345678901",
  "provider": "open-finance",
  "query_date": "2026-03-18T10:00:00",
  "results": {
    "PRODUTO_A": { "success": true, "data": { ... } },
    "PRODUTO_B": { "success": true, "data": { ... } }
  }
}

Como autenticar

Todas as consultas requerem um token JWT válido no header Authorization: Bearer {token}. Obtenha seu token via Authentication API.