Docs / Início / Quickstart

Quickstart

Faça sua primeira requisição em menos de 5 minutos.

1

Obtenha sua API Key

Acesse o Dev Portal e crie uma chave de teste. Chaves de teste usam o prefixo sk_test_ e apontam para o ambiente sandbox.

Nunca compartilhe sua API key. Chaves sk_live_ têm acesso à dados reais de produção.

2

Autentique via OAuth2

Use sua API key para obter um token de acesso:

const dinie = require('@dinie/sdk');

const client = new dinie.Client({
  apiKey: 'sk_test_sua_chave_aqui'
});

// O SDK gerencia o token automaticamente
const app = await client.creditApplications.create({
  cpf: '123.456.789-00',
  cnpj: '12.345.678/0001-90',
  email: 'cliente@empresa.com.br',
  phone: '+5511999887766'
});

console.log(app.id);  // "ca_8f3k2mNx"

import dinie

client = dinie.Client(
    api_key="sk_test_sua_chave_aqui"
)

# O SDK gerencia o token automaticamente
app = client.credit_applications.create(
    cpf="123.456.789-00",
    cnpj="12.345.678/0001-90",
    email="cliente@empresa.com.br",
    phone="+5511999887766"
)

print(app.id)  # "ca_8f3k2mNx"

require 'dinie'

client = Dinie::Client.new(
  api_key: "sk_test_sua_chave_aqui"
)

# O SDK gerencia o token automaticamente
app = client.credit_applications.create(
  cpf: "123.456.789-00",
  cnpj: "12.345.678/0001-90",
  email: "cliente@empresa.com.br",
  phone: "+5511999887766"
)

puts app.id  # "ca_8f3k2mNx"

# Primeiro, obtenha o token
curl -X POST https://api.dinie.com.br/v3/oauth/token \
  -H "Content-Type: application/json" \
  -d '{"api_key": "sk_test_sua_chave_aqui"}'

# Use o token para criar uma proposta
curl -X POST https://api.dinie.com.br/v3/credit-applications \
  -H "Authorization: Bearer TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "cpf": "123.456.789-00",
    "cnpj": "12.345.678/0001-90",
    "email": "cliente@empresa.com.br",
    "phone": "+5511999887766"
  }'

3

Acompanhe o resultado

A análise de crédito é assíncrona. Configure um webhook ou consulte o status via polling:

const status = await client.creditApplications.get('ca_8f3k2mNx');

console.log(status);
// {
//   "id": "ca_8f3k2mNx",
//   "status": "approved",        ← análise aprovada
//   "approved_amount": 25000.00,
//   "simulation": {
//     "installments": 12,
//     "monthly_payment": 2291.67,
//     "interest_rate": 2.5
//   }
// }

Jornada de Crédito Completa →

Do cadastro ao desembolso, passo a passo.

Configurar Webhooks →

Receba notificações em tempo real sobre eventos.

Docs / Início / Autenticação

Autenticação

A API V3 usa OAuth2 com API keys para autenticação.

Ambientes

A Dinie usa uma URL única com roteamento por chave de API. O prefixo da sua chave determina o ambiente:

Prefixo	Ambiente	Base URL
sk_live_	Produção	https://api.dinie.com.br/v3
sk_test_	Sandbox	https://api.dinie.com.br/v3

Mesma URL para ambos os ambientes! O roteamento é feito automaticamente com base no prefixo da chave, como no modelo do Stripe.

Docs / Guias / Jornada de Crédito

Jornada de Crédito

Fluxo completo: da proposta ao desembolso.

Cadastro 4 dados mínimos

Análise Bureau + políticas

Aprovação Simulação pronta

KYC + Docs Verificação

Assinatura CCB + ClickSign

Desembolso Transferência

Estados do CreditApplication

lead → analyzing → approved → docs_pending → signing → disbursed

↳ rejected (ciclo de retry: 4 meses)

Dados mínimos para criar uma proposta

São necessários apenas 4 campos para iniciar a análise de crédito:

cpf — CPF do solicitante

cnpj — CNPJ da empresa

email — E-mail de contato

phone — Telefone com DDD

Docs / Guias / Webhooks

Webhooks

Receba notificações em tempo real sobre eventos na Dinie.

Eventos disponíveis

Evento	Descrição	Quando
application.created	Proposta de crédito criada	Após POST /credit-applications
application.approved	Análise aprovada	Análise de crédito concluída
application.rejected	Proposta rejeitada	Cliente não elegível
documents.required	Documentos necessários	KYC pendente de envio
simulation.ready	Simulação disponível	Condições calculadas
loan.disbursed	Crédito desembolsado	Transferência confirmada

Validar assinatura HMAC

Sempre valide a assinatura do webhook para garantir que veio da Dinie:

const crypto = require('crypto');

function verifyWebhook(payload, signature, secret) {
  const expected = crypto
    .createHmac('sha256', secret)
    .update(payload)
    .digest('hex');

  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(expected)
  );
}

Docs / Guias / Erros & Best Practices

Erros & Best Practices

Como lidar com erros e padrões recomendados.

Catálogo de Erros

400 Bad Request

Corpo da requisição inválido ou campos ausentes.

{ "error": "validation_error", "message": "cpf is required", "field": "cpf" }

401 Unauthorized

Token expirado ou API key inválida.

{ "error": "authentication_error", "message": "Invalid or expired token" }

429 Rate Limited

Limite de requisições excedido. Respeite o header Retry-After.

{ "error": "rate_limit_exceeded", "retry_after": 30 }

Docs / Referência / API Reference

API Reference

Referência completa de todos os endpoints da API V3.

POST /v3/credit-applications Criar proposta de crédito

Body Parameters

cpf required string — CPF do solicitante (com ou sem máscara)

cnpj required string — CNPJ da empresa

email required string — E-mail para contato

phone required string — Telefone com DDD e código do país

Response 201

{
  "id": "ca_8f3k2mNx",
  "status": "lead",
  "cpf": "123.456.789-00",
  "cnpj": "12.345.678/0001-90",
  "email": "cliente@empresa.com.br",
  "phone": "+5511999887766",
  "created_at": "2026-02-11T14:30:00Z",
  "updated_at": "2026-02-11T14:30:00Z"
}

GET /v3/credit-applications/{id} Consultar proposta

GET /v3/credit-applications Listar propostas

POST /v3/credit-applications/{id}/documents Upload de documentos

POST /v3/loans Contratar empréstimo

GET /v3/loans/{id} Consultar empréstimo

GET /v3/loans/{id}/transactions Listar transações