Voltar para Documentação

Finance 360 API

Análise financeira via Open Finance — Renda, Despesas, Capacidade de Pagamento e Score.

Endpoint Base

POST /api/client/provider/open-finance

Produtos Disponíveis

8

Autenticação

Bearer JWT

Produtos Disponíveis

Análise de Crédito

ANALISE_CREDITO

Análise de crédito consolidada via Open Finance — renda, despesas (detalhadas por categoria), capacidade de pagamento e score em uma única consulta.

POST /api/client/provider/open-finance product_code: ["ANALISE_CREDITO"]
Ver Docs

Renda

RENDA

Estimativa de renda mensal do CPF com base na movimentação financeira Open Finance.

POST /api/client/provider/open-finance product_code: ["RENDA"]
Ver Docs

Despesas Recorrentes

DESPESAS

Detalhamento das despesas mensais do CPF por categoria (moradia, essenciais, obrigações financeiras, compras/lazer e transferências recorrentes).

POST /api/client/provider/open-finance product_code: ["DESPESAS"]
Ver Docs

Capacidade Financeira

CAPACIDADE_FINANCEIRA

Capacidade de pagamento (affordability) estimada do CPF — quanto sobra após as despesas.

POST /api/client/provider/open-finance product_code: ["CAPACIDADE_FINANCEIRA"]
Ver Docs

Vínculo Empregatício

VINCULO_EMPREGATICIO

Situação e tipo de vínculo empregatício do CPF (CLT, autônomo, etc.), dias de pagamento e CNPJ do empregador, inferidos via Open Finance.

POST /api/client/provider/open-finance product_code: ["VINCULO_EMPREGATICIO"]
Ver Docs

Score

SCORE

Score de crédito K3 do CPF (escala 0–1000) calculado a partir de dados Open Finance.

POST /api/client/provider/open-finance product_code: ["SCORE"]
Ver Docs

Dados Cadastrais

DADOS_CADASTRAIS

Dados cadastrais completos do CPF informados às instituições Open Finance vinculadas: identificação, contatos, endereços, documentos, renda/patrimônio informados e contas.

POST /api/client/provider/open-finance product_code: ["DADOS_CADASTRAIS"]
Ver Docs

Indicador de Apostas (Bets)

INDICADOR_BETS

Indicadores de comportamento de apostas (bets) do CPF — proporção de gastos com apostas sobre entradas e despesas, número de casas, tendências e score do indicador.

POST /api/client/provider/open-finance product_code: ["INDICADOR_BETS"]
Ver Docs

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": ["ANALISE_CREDITO","RENDA"]
  }'

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": { ... } }
  }
}

Ambiente de Homologação

sandbox

Os CPFs abaixo são documentos de teste e funcionam em qualquer ambiente, inclusive com credencial de produção. A consulta é respondida com dados fictícios, não é cobrada e não consome o limite mensal — permitem demonstrar o produto na mesma credencial usada para consultar o documento real do cliente. A resposta dessas consultas traz "demo": true.

Documento de Teste Cenário
12345678909 Perfil intermediário — score médio e dívidas relevantes
27182818205 Perfil sem dívidas — score alto e baixa movimentação
76109277673 Perfil sólido — score alto e capacidade folgada
98765432100 Perfil de atenção — despesas acima da renda

Qualquer outro CPF é consultado normalmente no provedor, com cobrança e consumo de limite. Com credencial de homologação, todas as consultas são servidas por estes mesmos dados de teste.

Como autenticar

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