# API Reference

Complete reference for the Dinie REST API v3. Resource-oriented, with predictable URLs, JSON, and standard HTTP codes.

## Base URLs

| Environment | URL |
|  --- | --- |
| Sandbox | `https://sandbox.api.dinie.com.br/v3` |
| Production | `https://api.dinie.com.br/v3` |


All examples in this documentation use the sandbox URL. Replace it when going to production. See the [Going to Production](/guides/going-to-production) guide for the full checklist.

## Concepts

Understand the technical fundamentals before integrating:

Authentication
OAuth 2.0 client credentials, access tokens, and credential rotation.

Errors
Standard error structure, HTTP codes, error types, and resolution.

Webhooks
Signature verification, retries, available events, and Standard Webhooks.

Idempotency
How to use `Idempotency-Key` to ensure safe retry operations.

Pagination
Cursor-based pagination, listing parameters, and result navigation.

## Resources

### Customers

Register and manage customers (borrowing companies).

| Method | Endpoint | Description |
|  --- | --- | --- |
| `POST` | `/v3/customers` | Register customer |
| `GET` | `/v3/customers` | List customers |
| `GET` | `/v3/customers/:id` | Retrieve customer |
| `PATCH` | `/v3/customers/:id` | Update customer |
| `POST` | `/v3/customers/:id/documents` | Upload document |
| `POST` | `/v3/customers/:id/biometrics` | Biometrics session |


### Credit Offers

Query credit offers automatically generated by Dinie's analysis.

| Method | Endpoint | Description |
|  --- | --- | --- |
| `GET` | `/v3/customers/:id/credit-offers` | List customer offers |
| `GET` | `/v3/credit-offers` | List all offers |
| `GET` | `/v3/credit-offers/:id` | Retrieve offer |


### Loans

Simulate, create, and query loans from credit offers.

| Method | Endpoint | Description |
|  --- | --- | --- |
| `POST` | `/v3/credit-offers/:id/simulations` | Create simulation |
| `POST` | `/v3/loans` | Create loan |
| `GET` | `/v3/loans/:id` | Retrieve loan |
| `GET` | `/v3/loans/:id/transactions` | List transactions |


### Webhooks

Configure endpoints to receive real-time event notifications.

| Method | Endpoint | Description |
|  --- | --- | --- |
| `POST` | `/v3/webhooks/endpoints` | Create endpoint |
| `GET` | `/v3/webhooks/endpoints` | List endpoints |
| `GET` | `/v3/webhooks/endpoints/:id` | Retrieve endpoint |
| `PATCH` | `/v3/webhooks/endpoints/:id` | Update endpoint |
| `DELETE` | `/v3/webhooks/endpoints/:id` | Delete endpoint |
| `POST` | `/v3/webhooks/endpoints/:id/secret/rotate` | Rotate secret |