> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dhmad.tn/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Welcome to the DHMAD API documentation. Learn how to integrate secure escrow and payment services into your application.

Welcome to the **DHMAD API** documentation. DHMAD provides a secure, reliable platform for escrow services and payment processing, allowing you to build trust into your marketplace, e-commerce, or service platform.

## What is DHMAD?

DHMAD is a secure escrow platform that acts as a trusted third party between buyers and sellers. Funds are held securely until both parties are satisfied with the transaction, providing peace of mind for all parties involved.

## Key Features

<CardGroup cols={2}>
  <Card title="Secure Escrow" icon="shield-check">
    Funds are held securely until transaction completion
  </Card>

  <Card title="Easy Integration" icon="plug">
    Simple REST API with comprehensive documentation
  </Card>

  <Card title="Real-time Updates" icon="bolt">
    Webhooks and real-time notifications for transaction status
  </Card>

  <Card title="Developer Friendly" icon="code">
    Built for developers with clear APIs and excellent support
  </Card>

  <Card title="Pre-account KYC" icon="id-card">
    Verify sellers before they join DHMAD via the [Identity Verifications API](/guides/kyc-for-marketplaces)
  </Card>
</CardGroup>

## Use Cases

DHMAD is perfect for:

* **Marketplaces**: Secure transactions between buyers and sellers, plus [pre-account seller KYC](/guides/kyc-for-marketplaces) before users sign up on DHMAD
* **Freelance Platforms**: Hold funds until work is completed — for example [Tunisie Freelance](https://tunisiefreelance.tn/), Tunisia’s freelance marketplace that uses DHMAD for payments
* **E-commerce**: Additional security layer for high-value transactions
* **Service Providers**: Escrow for service delivery
* **B2B Platforms**: Secure business-to-business transactions

## Sandbox

DHMAD offers a **sandbox environment** ([sandbox.dhmad.tn](https://sandbox.dhmad.tn)) for testing. Use `sk_sandbox_` API keys with `https://sandbox.dhmad.tn/api` — same API, separate data, no impact on production. See the [Sandbox guide](/guides/sandbox) for details.

## Getting Started

Ready to get started? Follow these steps:

1. **[Create a Developer Account](/getting-started)** - Apply for API access
2. **[Get Your API Keys](/authentication)** - Generate API keys in the dashboard
3. **[Associate User Account](/developer-portal/associating-accounts)** - Link your developer account to a user account
4. **[Make Your First Request](/quickstart)** - Create your first escrow

<Info>
  We recommend testing in the [sandbox](/guides/sandbox) before going live.
</Info>

## API Overview

The DHMAD API is a RESTful API that uses:

* **Base URL (production)**: `https://dhmad.tn/api/v1`
* **Base URL (sandbox)**: `https://sandbox.dhmad.tn/api/v1` — for testing; see [Sandbox](/guides/sandbox)
* **Authentication**: API Key via `Authorization: Bearer` or `X-API-Key` header
* **Content Type**: `application/json`
* **Rate Limiting**: 100 requests per minute per IP address (configurable)

## Support

Need help? We're here for you:

* **Email**: [support@dhmad.tn](mailto:support@dhmad.tn)
* **Documentation**: This site
* **Status Page**: [status.dhmad.tn](https://status.dhmad.tn)

***

<Note>
  All API endpoints require authentication. Make sure to include your API key in the `X-API-Key` header for all requests.
</Note>