> For the complete documentation index, see [llms.txt](https://developer.sahamati.org.in/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.sahamati.org.in/no-longer-relevent/technical-specifications/router-api-specs/integration-using-simulator/customisation-of-mock-entity-and-responses.md).

# Customisation of Mock Entity and Responses

This page explains how to use APIs to create custom mock entities for integration purposes. Additionally, responses for any scenario can be simulated by adding a custom expected response to a specific mock entity. The behavior of the created mock entities will default to the Response Simulator.

## Overview:

The Response Simulator is built to handle custom entities and responses for any request, while also mimicking the behavior of real Entity Protocol APIs. It offers a controlled environment for developers to test and validate custom scenarios without depending on the default behavior of the Response Simulator.

### Authorization:  

All the APIs listed below require a user token for authorization. Onboarded users can generate a token using their credentials, which can then be used to create mock entities, configure custom responses, and more. 

{% content-ref url="/pages/M5u704dsZBIuaZc1Kmg0" %}
[Identity & Access Management](/no-longer-relevent/technical-specifications/identity-and-access-management.md)
{% endcontent-ref %}

We recommend to use below postman collection for quicker access

{% file src="/files/sCvC2NGeoVgUOwRqezqc" %}

{% openapi src="/files/rjVj9IYRovGOMRu2Y3j2" path="/entity/mock/register" method="post" %}
[MockEntityCreate api.yml](https://content.gitbook.com/content/CKUjTKikPLYOjZEtClEd/blobs/ZT5qtzCsU8u6rGk6ywma/MockEntityCreate%20api.yml)
{% endopenapi %}

{% hint style="warning" %}

#### Regenerate the User Token after creating the mock entity to enable access to the newly created entity.

{% endhint %}

{% openapi src="/files/ltpRr3vQuHRIMhtPjZ8F" path="/response/add" method="post" %}
[Simulator api.yml](https://content.gitbook.com/content/CKUjTKikPLYOjZEtClEd/blobs/F67bUODEupSapOBLehgN/Simulator%20api.yml)
{% endopenapi %}

{% openapi src="/files/ltpRr3vQuHRIMhtPjZ8F" path="/response/list" method="post" %}
[Simulator api.yml](https://content.gitbook.com/content/CKUjTKikPLYOjZEtClEd/blobs/F67bUODEupSapOBLehgN/Simulator%20api.yml)
{% endopenapi %}


---

# 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://developer.sahamati.org.in/no-longer-relevent/technical-specifications/router-api-specs/integration-using-simulator/customisation-of-mock-entity-and-responses.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.