Portal do Desenvolvedor · Previnity

A API de crédito
que devs merecem.

Consultas de score, análise de risco e bureau de crédito em uma API REST moderna, rápida e bem documentada.

Começar agora → Ver endpoints
REST API  v2.1 99.9% uptime Sandbox grátis
consulta de score · resposta
// POST /v2/credit/score // Authorization: Bearer sk_live_•••••••• { "status": "success", "cpf": "•••.456.789-••", "score": 742, "faixa": "BOM", "probabilidade_inadimplencia": 0.08, "bureau": { "restricoes": false, "dividas": 0, "consultas_90d": 3 }, "updated_at": "2026-06-08T14:22:10Z" }
APIs disponíveis

Tudo que você precisa,
num único lugar.

Quatro módulos de crédito integrados, prontos pra produção com sandbox dedicado.

⚡
Score de Crédito
Score atualizado em tempo real com modelo proprietário Previnity. Resposta em <200ms.
POST/v2/credit/score
🛡️
Verificação de Identidade
Validação de CPF, nome, data de nascimento e biometria facial via selfie + documento.
POST/v2/identity/verify
📊
Relatório de Crédito
Relatório completo com histórico, restrições, protestos e consultas anteriores.
GET/v2/credit/report
🔍
Análise de Risco
Score composto com análise comportamental, dados bureau e modelos de machine learning.
POST/v2/risk/analyze
Guia rápido

Em produção
em 5 minutos.

01

Instale o SDK

Disponível para Node.js, Python e PHP. Ou use direto via REST com qualquer HTTP client.

02

Configure sua chave de API

Gere sua sk_live_ no console. Use sk_test_ para sandbox sem custo.

03

Faça sua primeira consulta

Score de crédito, verificação de identidade ou relatório completo — todos com o mesmo padrão de resposta JSON.

bash · node.js
# 1. instale o SDK $ npm install @previnity/sdk # ───────────────────────────────── // 2. inicialize com sua chave import Previnity from '@previnity/sdk' const prev = new Previnity({ apiKey: 'sk_live_••••••••••••' }) # ───────────────────────────────── // 3. primeira consulta const score = await prev.credit.score({ cpf: '123.456.789-00' }) console.log(score.score) // 742 console.log(score.faixa) // "BOM"
Referência

Endpoints

Método Endpoint Descrição Auth
POST /v2/credit/score Score de crédito em tempo real Bearer
GET /v2/credit/report/{cpf} Relatório completo de crédito Bearer
POST /v2/identity/verify Verificação de identidade (KYC) Bearer
POST /v2/risk/analyze Análise de risco composta Bearer
GET /v2/bureau/restrictions/{cpf} Restrições e protestos no bureau Bearer
POST /v2/auth/token Geração de token de acesso API Key

Pronto pra integrar?

Crie sua conta, gere sua chave de sandbox e comece sem custo.

Ver documentação Criar conta →