Source: https://docs.debitura.com/api/customer

# Customer API Overview

The Customer API enables businesses to programmatically create and manage debt collection cases. Use this API to integrate Debitura into your existing workflows, automate case submissions, and track collection status.

New to the Customer API?

Start with the **[Clients Integration Track](https://docs.debitura.com/clients.md)** for step-by-step guides, or jump straight to the **[Quickstart](https://docs.debitura.com/clients/getting-started/quickstart-create-first-case.md)** to create your first case.

<a id="base-urls"></a>

## Base URLs

| Environment | URL |
| --- | --- |
| **Production** | `https://customer-api.debitura.com` |

There is no separate test environment for the Customer API. Use `"isTest": true` on case creation to submit test cases without triggering real collection activity. See [Test Cases](https://docs.debitura.com/developer-concepts/test-cases.md).

<a id="authentication"></a>

## Authentication

Authenticate using an API key in the `XApiKey` header.

```bash
curl -H "XApiKey: your-api-key" \
  https://customer-api.debitura.com/me
```

Generate your API key at [app.debitura.com/CreditorApiKey](https://app.debitura.com/CreditorApiKey).

**Learn more:** [Authentication Guide](https://docs.debitura.com/clients/getting-started/authentication.md)

<a id="api-reference"></a>

## API Reference

Every endpoint is in the sidebar, one page per resource.

<a id="key-endpoints"></a>

### Key Endpoints

| Category | Description | Guide |
| --- | --- | --- |
| [Cases](https://docs.debitura.com/api/customer-api/cases.md) | Create, list, and manage collection cases | [Create a Case](https://docs.debitura.com/clients/integration-guides/create-a-case.md) |
| [Payments](https://docs.debitura.com/api/customer-api/payments.md) | Track payments received on cases | [Payments & Reconciliation](https://docs.debitura.com/clients/integration-guides/payments-and-reconciliation.md) |
| [Coverage](https://docs.debitura.com/api/customer-api/coverage.md) | Check jurisdiction coverage and eligibility | — |
| [Contracts](https://docs.debitura.com/api/customer-api/contracts.md) | Manage debt collection agreements | — |
| [Webhooks](https://docs.debitura.com/api/customer-api/webhooks.md) | Subscribe to case status events | [Webhook Integration](https://docs.debitura.com/clients/integration-guides/webhooks.md) |

<a id="integration-guides"></a>

## Integration Guides

| Guide | Description |
| --- | --- |
| [Quickstart](https://docs.debitura.com/clients/getting-started/quickstart-create-first-case.md) | Create your first case in 5 minutes |
| [Create a Case](https://docs.debitura.com/clients/integration-guides/create-a-case.md) | Full guide to case creation with validation |
| [Track Case Status](https://docs.debitura.com/clients/integration-guides/track-case-status.md) | Monitor case progress and handle transitions |
| [Upload Documents](https://docs.debitura.com/clients/integration-guides/upload-documents.md) | Attach invoices and supporting files |
| [Webhook Integration](https://docs.debitura.com/clients/integration-guides/webhooks.md) | Receive real-time status updates |
| [Payments & Reconciliation](https://docs.debitura.com/clients/integration-guides/payments-and-reconciliation.md) | Track collections and reconcile payments |

<a id="concepts"></a>

## Concepts

| Topic | Description |
| --- | --- |
| [Claim Amount and Age](https://docs.debitura.com/developer-concepts/claim-amount-and-age.md) | Choose how case principal and aging data are supplied |
| [Client Divisions](https://docs.debitura.com/clients/concepts/client-divisions.md) | Organize cases by business unit or entity |
| [Authentication](https://docs.debitura.com/developer-concepts/authentication.md) | API keys and security |
| [Error Handling](https://docs.debitura.com/developer-concepts/error-handling.md) | Error response format and codes |
| [Webhooks](https://docs.debitura.com/developer-concepts/webhooks.md) | Event payload format and verification |

<a id="need-help"></a>

## Need Help?

-   **Troubleshooting:** [Common Issues](https://docs.debitura.com/clients/troubleshooting.md)
-   **Technical questions:** [contact@debitura.com](mailto:contact@debitura.com)
-   **Support center:** [support.debitura.com](https://support.debitura.com/)
