> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/platform/deep-dive/api-specifications.md).

# API Specifications

DIGIT offers several API collections that help integrate services on the platform. The table below enlists the DIGIT Core Service APIs and the link to related service configuration docs.

{% embed url="<https://specs.digit.org/common-service-specs>" %}

<table><thead><tr><th width="195">API List</th><th width="412">Description</th><th>Service Configuration Docs</th></tr></thead><tbody><tr><td><a href="https://specs.digit.org/common-service-specs/user">User Management</a></td><td>Create, Update, Search, Password Update, Reset Password</td><td><a href="https://docs.digit.org/platform/build/core-services/user.md">User Services</a></td></tr><tr><td><a href="https://specs.digit.org/common-service-specs/access-control">Access Control - Authorisation Management</a></td><td>Create new roles, Update existing roles, Search for a list of roles based on role codes, Create new actions, Update existing actions, Map roles and features, Map roles and actions, Validate tenant actions &#x26; roles</td><td><a href="https://docs.digit.org/platform/build/core-services/access-control-services.md">Access Control Services</a></td></tr><tr><td><a href="https://specs.digit.org/common-service-specs/employee">Employee Registry</a></td><td>Add employee, Update employee data, Generate count for list of active &#x26; inactive employees, Search for employees</td><td></td></tr><tr><td><a href="https://core.digit.org/master/platform/specifications/location">Location - Manage Location Details</a></td><td>Search list of boundaries, search geographical boundaries, Search for tenant id based on latitude and longitude</td><td><a href="https://docs.digit.org/platform/build/core-services/location.md">Location Services</a></td></tr><tr><td><a href="https://core.digit.org/master/platform/specifications/localisation">Localisation - Manage Localisation Details</a></td><td>Localise messages, Update localised messages, Delete localised messages, Get messages by locale and tenant ID</td><td><a href="https://docs.digit.org/platform/build/core-services/localization-service.md">Localization Service</a></td></tr><tr><td><a href="https://specs.digit.org/common-service-specs/encryption">Encryption - Manage Data Encryption Details</a></td><td>Encrypt given values, Decrypt given values, Provide signature for given values, Verify signature, Deactivate keys for given tenant and generate new key</td><td><a href="https://docs.digit.org/platform/build/core-services/encryption-service.md">Encryption Service</a></td></tr><tr><td><a href="https://specs.digit.org/common-service-specs/indexer">Indexer - Indexing Services</a></td><td>Index records, Reindex records, Start legacy index job to reindex records</td><td><a href="https://docs.digit.org/platform/build/core-services/indexer-service.md">Indexer Service</a></td></tr><tr><td><a href="https://specs.digit.org/common-service-specs/filestore">File Store</a></td><td>Upload files to servers, Search file url based on tenantid and filestoreid, Search file url based on tenantid and tag name, Get metadata of file based on tenantID and filestoreID</td><td><a href="https://docs.digit.org/platform/build/core-services/filestore-service.md">Filestore Service</a></td></tr><tr><td><a href="https://specs.digit.org/common-service-specs/collection">Collection</a></td><td>Record payments in the system, Perform workflow actions on payment, Validate payment request, Search payment based on given search criteria</td><td><a href="https://urban.digit.org/platform/configure-digit/services-overview/business-services/collection-service/collection-service-v2">Collection Service</a></td></tr><tr><td><a href="https://specs.digit.org/common-service-specs/master-data-management">Master Data Management</a></td><td>Create/Update master data, Get master data for listed tenantID or module</td><td><a href="https://docs.digit.org/platform/build/core-services/mdms-v2-master-data-management-service/mdms-master-data-management-service.md">Master Data Management Service</a></td></tr><tr><td><a href="https://specs.digit.org/common-service-specs/id-generation">ID Generation</a></td><td>Generate new ID</td><td><a href="https://docs.digit.org/platform/build/core-services/id-generation-service.md">ID Generation Service</a></td></tr><tr><td><a href="https://specs.digit.org/common-service-specs/url-shortening">URL Shortener</a></td><td>Shorten URL, Redirects user to the original URL</td><td><a href="https://docs.digit.org/platform/build/core-services/url-shortening-service.md">URL Shortening Service</a></td></tr><tr><td><a href="https://specs.digit.org/common-service-specs/workflow">Workflow Service</a></td><td>Create/Update/Search new business service, Create new workflow entry, Get the list of workflows, Get count of applications</td><td><a href="https://docs.digit.org/platform/build/core-services/workflow.md">Workflow Service</a></td></tr><tr><td><a href="https://specs.digit.org/common-service-specs/otp">OTP Service</a></td><td>Create/Validate/Search OTP configuration entry</td><td><a href="https://docs.digit.org/platform/build/core-services/otp-service.md">OTP Service</a></td></tr><tr><td><a href="https://specs.digit.org/common-service-specs/pdf-generation">PDF Generation Service</a></td><td>Create/Search pdf</td><td><a href="https://docs.digit.org/platform/build/core-services/pdf-generation-service.md">PDF Generation Service</a></td></tr><tr><td><a href="https://specs.digit.org/common-service-specs/payment-gateway">Payment Gateway Service</a></td><td>Create new payment instruction / Update existing payment /Retrieve current status of payment</td><td><a href="https://docs.digit.org/platform/build/core-services/payment-gateway-service.md">Payment Gateway Service</a></td></tr><tr><td><a href="https://specs.digit.org/common-service-specs/decision-support-system-ingest">DSS Ingest</a></td><td>Decision support systems - manage and facilitate data ingest</td><td></td></tr><tr><td></td><td></td><td></td></tr></tbody></table>


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.digit.org/platform/deep-dive/api-specifications.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
