> For the complete documentation index, see [llms.txt](https://docs.emudhradigital.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.emudhradigital.com/api-reference/api-reference-overview.md).

# API Reference Overview

This section summarises the APIs for eMudhra's eSign and signing services, based on the CCA eSign API specifications. Use it with the product guides in the **Documentation** section. Each API has an interactive Swagger reference, linked from its overview page.

## APIs at a glance

| API                              | Based on                 | Style                                                   | Swagger                                                  |
| -------------------------------- | ------------------------ | ------------------------------------------------------- | -------------------------------------------------------- |
| eSign v2 — Online Aadhaar        | CCA eSign API 2.1        | Signed XML over HTTPS, synchronous redirect             | [Swagger](https://todo-swagger-url/esign-v2)             |
| eSign v3 — CA eKYC Account       | CCA eSign API 3.3        | Signed XML over HTTPS, asynchronous (callback + status) | [Swagger](https://todo-swagger-url/esign-v3)             |
| Remote Key Storage               | CCA eSign Remote API 1.1 | Form redirect (enrolment) + signed XML (signing)        | [Swagger](https://todo-swagger-url/remote-key-storage)   |
| Remote Signing (Document Signer) | eMudhra API              | REST / JSON                                             | [Swagger](https://todo-swagger-url/remote-signing)       |
| Signature Validation             | eMudhra API              | REST / JSON                                             | [Swagger](https://todo-swagger-url/signature-validation) |

## Environments

| Environment          | Purpose                                  | Base URL                 |
| -------------------- | ---------------------------------------- | ------------------------ |
| UAT / Pre-production | Integration testing with test identities | *Provided at onboarding* |
| Production           | Live transactions                        | *Provided at onboarding* |

Each environment has its own `aspId`, ASP signing certificate mapping and IP allow-list.

## Before you start

1. Complete ASP onboarding and receive your `aspId`.
2. Register the certificate you will use to sign request XML.
3. Allow-list your server IPs and make your `responseUrl` reachable over HTTPS.
4. Read **Conventions and Security** for the rules common to all eSign APIs.

{% hint style="warning" %}
Swagger links on these pages are placeholders and will be updated when the OpenAPI definitions are published.
{% endhint %}