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

# API

This page is the entry point for eSignet's full API surface — every endpoint eSignet exposes, with exact request and response schemas, parameters, and status codes. If you're looking for a conceptual walkthrough of connecting a relying party instead, start with Development and Integration with eSignet; come back here once you need the precise contract for a specific call.

### OpenAPI Specification

The authoritative, machine-readable definition of every endpoint eSignet exposes — request and response schemas, required parameters, authentication requirements, and error responses — maintained directly in the eSignet repository alongside the code it describes. Refer to it whenever you need the exact contract for a specific endpoint.

[eSignet OpenAPI Specification](https://github.com/mosip/esignet/blob/master/docs/esignet-openapi.yaml)

### Postman Collection

A ready-to-import Postman collection covering eSignet's API surface, useful for exploring endpoints interactively or trying calls against a running instance without writing any client code first.

[eSignet Postman Collection](https://github.com/mosip/esignet/tree/master/postman-collection)

{% hint style="info" %}
**Note:** Both resources are versioned alongside the eSignet codebase. Use the version of each that matches the eSignet release you're integrating against.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.esignet.io/home/esignet-2.0.0/develop/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.