API Reference

Referência completa da API REST Dinie v3. Orientada a recursos, com URLs previsíveis, JSON e códigos HTTP padrão.

URLs Base

Ambiente	URL
Sandbox	`https://sandbox.api.dinie.com.br/v3`
Produção	`https://api.dinie.com.br/v3`

Todos os exemplos desta documentação usam a URL de sandbox. Substitua ao ir para produção. Veja o guia Indo para Produção para o checklist completo.

Entenda os fundamentos técnicos antes de integrar:

OAuth 2.0 client credentials, tokens de acesso e rotação de credenciais.

Estrutura de erro padrão, códigos HTTP, tipos de erro e resolução.

Verificação de assinatura, retentativas, eventos disponíveis e Standard Webhooks.

Como usar Idempotency-Key para garantir operações seguras em retentativas.

Paginação baseada em cursor, parâmetros de listagem e navegação de resultados.

Cadastre e gerencie clientes (empresas tomadoras de crédito).

Método	Endpoint	Descrição
`POST`	`/v3/customers`	Cadastrar cliente
`GET`	`/v3/customers`	Listar clientes
`GET`	`/v3/customers/:id`	Consultar cliente
`PATCH`	`/v3/customers/:id`	Atualizar cliente
`POST`	`/v3/customers/:id/kyc-attachments`	Enviar documento KYC
`POST`	`/v3/customers/:id/biometrics`	Sessão de biometria

Consulte ofertas de crédito geradas automaticamente pela análise da Dinie.

Simule, crie e consulte empréstimos a partir de ofertas de crédito.

Método	Endpoint	Descrição
`POST`	`/v3/credit-offers/:id/simulations`	Criar simulação
`POST`	`/v3/loans`	Criar empréstimo
`GET`	`/v3/loans/:id`	Consultar empréstimo
`GET`	`/v3/loans/:id/transactions`	Listar transações

Configure endpoints para receber notificações de eventos em tempo real.

Método	Endpoint	Descrição
`POST`	`/v3/webhooks/endpoints`	Criar endpoint
`GET`	`/v3/webhooks/endpoints`	Listar endpoints
`GET`	`/v3/webhooks/endpoints/:id`	Consultar endpoint
`PATCH`	`/v3/webhooks/endpoints/:id`	Atualizar endpoint
`DELETE`	`/v3/webhooks/endpoints/:id`	Remover endpoint
`POST`	`/v3/webhooks/endpoints/:id/secret/rotate`	Rotacionar secret