# Dinie API

API de crédito embarcado para parceiros Dinie. Gerencie clientes, ofertas de crédito, empréstimos e webhooks

Version: 2026-03-01
License: Proprietary

## Servers

[object Object]
```
https://api.dinie.com/api/v3
```

Sandbox
```
https://api-dev.dinietech.io/api/v3
```

## Security

### bearerAuth

[object Object]

Type: http
Scheme: bearer
Bearer Format: JWT

### oauth2

[object Object]

Type: oauth2
Token URL: /api/v3/auth/token
Scopes:
- `kyc:read`: Read a customer's KYC state (requirements, attachments, status).
- `kyc:upload`: Upload a KYC attachment (document or selfie via the dedicated route).
- `kyc:submit`: Submit a customer's KYC bundle for review.
- `biometrics:create`: Mint a biometrics capture session for a customer (partner side of the handoff).
- `biometrics:exchange`: Exchange a biometrics bootstrap code for a scoped session token (kyc-app side of the handoff).

### webhookSignature

[object Object]

Type: apiKey
In: header
Name: webhook-signature

## Download OpenAPI description

 - [Dinie API](https://docs.dinie.com/_bundle/apis/openapi.yaml)

## Autenticação

 - [POST /auth/token](https://docs.dinie.com/apis/openapi/authentication/createtoken.md): POST /auth/tokenTroca credenciais do parceiro por um token de acesso via OAuth2 Client Credentials
 - [POST /auth/credentials](https://docs.dinie.com/apis/openapi/authentication/createcredential.md): POST /auth/credentialsCria um novo par de credenciais de API
 - [GET /auth/credentials](https://docs.dinie.com/apis/openapi/authentication/listcredentials.md): GET /auth/credentialsLista todas as chaves de API
 - [DELETE /auth/credentials/{client_id}](https://docs.dinie.com/apis/openapi/authentication/revokecredential.md): DELETE /auth/credentials/{client_id}Revoga imediata e permanentemente uma chave de API
## Clientes

 - [POST /customers](https://docs.dinie.com/apis/openapi/customers/createcustomer.md): POST /customersCadastra um novo cliente
 - [GET /customers](https://docs.dinie.com/apis/openapi/customers/listcustomers.md): GET /customersLista clientes
 - [GET /customers/{customer_id}](https://docs.dinie.com/apis/openapi/customers/getcustomer.md): GET /customers/{customer_id}Consulta um cliente
 - [PATCH /customers/{customer_id}](https://docs.dinie.com/apis/openapi/customers/updatecustomer.md): PATCH /customers/{customer_id}Atualiza dados do cliente
 - [POST /customers/{customer_id}/kyc-attachments](https://docs.dinie.com/apis/openapi/customers/uploadkycattachment.md): POST /customers/{customer_id}/kyc-attachmentsEnvia um arquivo para um requisito KYC
 - [GET /customers/{customer_id}/bank-account](https://docs.dinie.com/apis/openapi/customers/getcustomerbankaccount.md): GET /customers/{customer_id}/bank-accountRetorna a conta bancária vinculada a este cliente, se houver
 - [POST /customers/{customer_id}/bank-account](https://docs.dinie.com/apis/openapi/customers/upsertcustomerbankaccount.md): POST /customers/{customer_id}/bank-accountCria ou atualiza a conta bancária vinculada a este cliente. Disponível para tokens de sessão de biometria, permitindo que o kyc-app colete os dados bancários
 - [GET /banks](https://docs.dinie.com/apis/openapi/customers/listbanks.md): GET /banksLista os bancos disponíveis para cadastro de conta bancária do cliente
 - [POST /customers/{customer_id}/biometrics](https://docs.dinie.com/apis/openapi/customers/createbiometricssession.md): POST /customers/{customer_id}/biometricsCria uma sessão de captura biométrica
 - [POST customer.created](https://docs.dinie.com/apis/openapi/customers/oncustomercreated.md): Cadastro completo, requisitos KYC prontos
 - [POST customer.under_review](https://docs.dinie.com/apis/openapi/customers/oncustomerunderreview.md): Todos os KYC obrigatórios enviados, verificação em andamento
 - [POST customer.kyc_updated](https://docs.dinie.com/apis/openapi/customers/oncustomerkycupdated.md): Requisito KYC enviado ou status de análise alterado
 - [POST customer.active](https://docs.dinie.com/apis/openapi/customers/oncustomeractive.md): Verificação KYC completa, cliente aprovado
 - [POST customer.denied](https://docs.dinie.com/apis/openapi/customers/oncustomerdenied.md): Cliente permanentemente bloqueado
## Ofertas de Crédito

 - [GET /customers/{customer_id}/credit-offers](https://docs.dinie.com/apis/openapi/credit-offers/listcustomercreditoffers.md): GET /customers/{customer_id}/credit-offersLista ofertas de crédito de um cliente
 - [GET /credit-offers](https://docs.dinie.com/apis/openapi/credit-offers/listcreditoffers.md): GET /credit-offersLista ofertas de crédito de todos os clientes
 - [GET /credit-offers/{credit_offer_id}](https://docs.dinie.com/apis/openapi/credit-offers/getcreditoffer.md): GET /credit-offers/{credit_offer_id}Consulta uma oferta de crédito
 - [POST credit_offer.available](https://docs.dinie.com/apis/openapi/credit-offers/oncreditofferavailable.md): Nova oferta de crédito disponível para saque
 - [POST credit_offer.expired](https://docs.dinie.com/apis/openapi/credit-offers/oncreditofferexpired.md): Oferta de crédito expirada ou substituída
## Empréstimos

 - [POST /credit-offers/{credit_offer_id}/simulations](https://docs.dinie.com/apis/openapi/loans/createsimulation.md): POST /credit-offers/{credit_offer_id}/simulationsSimula condições de empréstimo para uma oferta de crédito
 - [POST /loans](https://docs.dinie.com/apis/openapi/loans/createloan.md): POST /loansAceita uma oferta de crédito e cria um empréstimo
 - [GET /loans/{loan_id}](https://docs.dinie.com/apis/openapi/loans/getloan.md): GET /loans/{loan_id}Consulta um empréstimo
 - [GET /loans/{loan_id}/transactions](https://docs.dinie.com/apis/openapi/loans/listtransactions.md): GET /loans/{loan_id}/transactionsLista transações de um empréstimo
 - [POST loan.created](https://docs.dinie.com/apis/openapi/loans/onloancreated.md): Empréstimo criado, aguardando assinaturas do contrato
 - [POST loan.signature_received](https://docs.dinie.com/apis/openapi/loans/onloansignaturereceived.md): Um signatário concluiu sua assinatura
 - [POST loan.processing](https://docs.dinie.com/apis/openapi/loans/onloanprocessing.md): Todas as assinaturas coletadas, desembolso em andamento
 - [POST loan.active](https://docs.dinie.com/apis/openapi/loans/onloanactive.md): Empréstimo desembolsado, ciclo de pagamento iniciado
 - [POST loan.payment_received](https://docs.dinie.com/apis/openapi/loans/onloanpaymentreceived.md): Pagamento de parcela recebido
 - [POST loan.finished](https://docs.dinie.com/apis/openapi/loans/onloanfinished.md): Empréstimo totalmente pago
 - [POST loan.cancelled](https://docs.dinie.com/apis/openapi/loans/onloancancelled.md): Empréstimo cancelado antes do desembolso
 - [POST loan.error](https://docs.dinie.com/apis/openapi/loans/onloanerror.md): Erro no desembolso ou processamento
## Webhooks

 - [POST /webhooks/endpoints](https://docs.dinie.com/apis/openapi/webhooks/createwebhookendpoint.md): POST /webhooks/endpointsRegistra um endpoint de webhook
 - [GET /webhooks/endpoints](https://docs.dinie.com/apis/openapi/webhooks/listwebhookendpoints.md): GET /webhooks/endpointsLista endpoints de webhook
 - [GET /webhooks/endpoints/{webhook_endpoint_id}](https://docs.dinie.com/apis/openapi/webhooks/getwebhookendpoint.md): GET /webhooks/endpoints/{webhook_endpoint_id}Consulta um endpoint de webhook
 - [PATCH /webhooks/endpoints/{webhook_endpoint_id}](https://docs.dinie.com/apis/openapi/webhooks/updatewebhookendpoint.md): PATCH /webhooks/endpoints/{webhook_endpoint_id}Atualiza um endpoint de webhook
 - [DELETE /webhooks/endpoints/{webhook_endpoint_id}](https://docs.dinie.com/apis/openapi/webhooks/deletewebhookendpoint.md): DELETE /webhooks/endpoints/{webhook_endpoint_id}Exclui um endpoint de webhook
 - [POST /webhooks/endpoints/{webhook_endpoint_id}/rotate-secret](https://docs.dinie.com/apis/openapi/webhooks/rotatewebhooksecret.md): POST /webhooks/endpoints/{webhook_endpoint_id}/rotate-secretRotaciona o secret de assinatura de um webhook
 - [GET /webhooks/endpoints/{endpoint_id}/deliveries](https://docs.dinie.com/apis/openapi/webhooks/listwebhookdeliveries.md): GET /webhooks/endpoints/{endpoint_id}/deliveriesHistórico paginado de entregas de um endpoint de webhook, das mais recentes para as mais antigas
 - [POST /webhooks/endpoints/{endpoint_id}/deliveries/{id}/retry](https://docs.dinie.com/apis/openapi/webhooks/retrywebhookdelivery.md): POST /webhooks/endpoints/{endpoint_id}/deliveries/{id}/retryReinicia uma entrega que falhou e a recoloca na fila. Apenas entregas com status `failed` podem ser reenviadas