# Central Registry JSON Template

## CR Entity Registration

**API Parameter Reference · FIP / FIU / AA**

This document describes every parameter in the Central Registry entity registration JSON payload. Fields marked **Required** must be present for all entity types. Fields marked **FIP only** / **AA only** apply exclusively to that entity type. Fields marked **Ignore** are reserved for future use.

### Root-Level Parameters

<table><thead><tr><th width="152.111083984375">Field / Parameter</th><th width="132.111083984375">Type</th><th>Required</th><th>Description</th><th>Example Value</th></tr></thead><tbody><tr><td><code>ver</code></td><td>String</td><td><strong>Required</strong></td><td>Version of the API/schema being used.</td><td><code>2.0</code></td></tr><tr><td><code>timestamp</code></td><td>String (ISO 8601)</td><td><strong>Required</strong></td><td>UTC timestamp of the request in ISO 8601 format.</td><td><code>2026-03-18T08:04:50.314Z</code></td></tr><tr><td><code>txnid</code></td><td>String (UUID)</td><td><strong>Required</strong></td><td>Unique transaction ID for tracking this request.</td><td><code>407a70dd-88dd-423d-97a6-edbc0d0694da</code></td></tr><tr><td><code>type</code></td><td>String (Enum)</td><td><strong>Required</strong></td><td>Entity type being registered. One of: <code>FIP</code>, <code>FIU</code>, <code>AA</code>.</td><td><code>FIU</code></td></tr></tbody></table>

### `requester` — Identifies the party submitting the request

<table><thead><tr><th width="151.66668701171875">Field / Parameter</th><th width="104.5555419921875">Type</th><th width="122.666748046875">Required</th><th>Description</th><th>Example Value</th></tr></thead><tbody><tr><td><code>requester.name</code></td><td>String</td><td><strong>Required</strong></td><td>Display name of the entity submitting the request.</td><td><code>Sahamati FIU Test</code></td></tr><tr><td><code>requester.id</code></td><td>String</td><td><strong>Required</strong></td><td>Unique ID of the requesting entity as registered in the CR.</td><td><code>sahamati-fiu-test-new</code></td></tr></tbody></table>

### `entityinfo` — Core entity registration details

<table><thead><tr><th width="149">Field / Parameter</th><th width="105.44439697265625">Type</th><th width="131.111083984375">Required</th><th width="202.3333740234375">Description</th><th>Example Value</th></tr></thead><tbody><tr><td><code>entityinfo.tags</code></td><td>String</td><td>Optional</td><td>Environment tag for the entity (e.g. <code>Sandbox</code>, <code>Production</code>).</td><td><code>Sandbox</code></td></tr><tr><td><code>entityinfo.name</code></td><td>String</td><td><strong>Required</strong></td><td>Name of the entity as submitted while listing itself in the CR. <br>Note: <strong>Ensure this matches exactly as mentioned in your Certificate of Registration (CoR) issued by your regulator</strong>.</td><td><code>Sahamati Foundation</code></td></tr><tr><td><code>entityinfo.id</code></td><td>String</td><td><strong>Required</strong></td><td>Unique ID issued by the CR to the entity.<br>Note: <strong>Please refer to</strong> <a href="https://membersuccess.sahamati.org.in/member-services/cr-pre-onboarding-guide/entity-id-naming-convention"><strong>this page</strong></a> <strong>for your Entity ID naming convention.</strong></td><td><code>sahamati-fiu-test-new</code></td></tr><tr><td><code>entityinfo.code</code></td><td>String</td><td><strong>Required</strong></td><td>ID issued by the financial sector regulator governing this entity.<br>Note: <strong>Ensure this matches exactly as mentioned in your Certificate of Registration (CoR) issued by your regulator.</strong></td><td></td></tr><tr><td><code>entityinfo.entityhandle</code></td><td>String</td><td>AA only</td><td>Handle suffix for user profiles managed by the AA (e.g. <code>@aa</code>). Leave blank for FIU/FIP.</td><td></td></tr></tbody></table>

### `entityinfo.Identifiers` — Account discovery identifiers

*(FIP only; present here for schema completeness)*

| Field / Parameter        | Type          | Required | Description                                                                                   | Example Value |
| ------------------------ | ------------- | -------- | --------------------------------------------------------------------------------------------- | ------------- |
| `Identifiers[].category` | String (Enum) | FIP only | Category of identifier accepted for account discovery. Values: `STRONG`, `WEAK`, `ANCILLARY`. | `STRONG`      |
| `Identifiers[].type`     | String (Enum) | FIP only | Type of identifier (e.g. `MOBILE`, `PAN`, `DOB`). At least one must be `STRONG`.              | `MOBILE`      |

### `entityinfo` — Connectivity & Endpoints

| Field / Parameter          | Type           | Required     | Description                                                                                                            | Example Value                                       |
| -------------------------- | -------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
| `entityinfo.baseurl`       | String (URL)   | **Required** | URL hosting all ReBIT-compliant API endpoints. Prefix with version e.g. `v2:` for versioned URLs.                      | `v2:https://data.sahamati.com/fiu/sahamati-test/v2` |
| `entityinfo.webviewurl`    | String (URL)   | AA only      | URL of the AA web app for FIUs to redirect users to. `null` for FIU/FIP.                                               | `null`                                              |
| `entityinfo.fitypes`       | Array\<String> | FIP only     | Financial information types from the ReBIT master list that the entity supports. Present here for schema completeness. | `DEPOSIT, MUTUAL_FUNDS, EQUITIES...`                |
| `entityinfo.inboundports`  | Array\<String> | **Required** | Ports on the entity that counterparties (AA/FIP/FIU) can connect to.                                                   | `["443"]`                                           |
| `entityinfo.outboundports` | Array\<String> | **Required** | Ports from which the entity will make outbound requests.                                                               | `["443"]`                                           |
| `entityinfo.ips`           | Array\<String> | **Required** | IP addresses counterparties may send and receive requests to/from.                                                     | `["13.127.138.226"]`                                |

### `entityinfo.certificate` — Public key in JSON Web Key (JWK) format

| Field / Parameter | Type   | Required     | Description                                              | Example Value                          |
| ----------------- | ------ | ------------ | -------------------------------------------------------- | -------------------------------------- |
| `certificate.alg` | String | **Required** | Algorithm used. Typically `RS256`.                       | `RS256`                                |
| `certificate.kty` | String | **Required** | Key type. Must be `RSA`.                                 | `RSA`                                  |
| `certificate.use` | String | **Required** | Intended use of the key. `sig` = signature verification. | `sig`                                  |
| `certificate.kid` | String | **Required** | Key ID — unique identifier for this key.                 | `ed9c4269-96de-4a62-b057-e2dd628d359c` |
| `certificate.e`   | String | **Required** | RSA public exponent (Base64url encoded).                 | `AQAB`                                 |
| `certificate.n`   | String | **Required** | RSA modulus — the public key value (Base64url encoded).  | `ngB4ScutfK6776QK...`                  |

### `entityinfo.gsp` — Gateway Service Provider

(Leave these Field/Parameter values as null — Reserved for future use)

| Field / Parameter | Type | Required | Description                                                                                    | Example Value |
| ----------------- | ---- | -------- | ---------------------------------------------------------------------------------------------- | ------------- |
| `gsp`             | null | null     | GSP details when a gateway sits between AAs and the FIP (e.g. GSTN). Set to `null` for FIU/AA. | `null`        |

### `entityinfo.tokeninfo` — Token issuance details

(Leave these Field/Parameter values as empty — Reserved for future use)

| Field / Parameter | Type         | Required   | Description                                                          | Example Value |
| ----------------- | ------------ | ---------- | -------------------------------------------------------------------- | ------------- |
| `tokeninfo.url`   | String (URL) | Keep Empty | URL of the entity's Token Issuance Service. Reserved for future use. | `""`          |
| `tokeninfo.desc`  | String       | Keep Empty | Description field. Reserved for future use.                          | `""`          |

### `entityinfo.signature` — Request signature

(Leave these Field/Parameter values as empty — Reserved for future use)

| Field / Parameter     | Type   | Required   | Description                                                              | Example Value |
| --------------------- | ------ | ---------- | ------------------------------------------------------------------------ | ------------- |
| `signature.signValue` | String | Keep Empty | Cryptographic signature of the request payload. Reserved for future use. | `""`          |

***

### Notes

* `baseurl` will be prefixed with a version tag (e.g. v2:https\://...) to indicate the supported API version.
* `certificate` fields follow the JSON Web Key (RFC 7517) specification.
* `tokeninfo` and `signature` fields are present in the schema but should be left empty / ignored until further notice.
* `gsp` must be set to `null` for FIU and AA entity types.
* `entityhandle` and `webviewurl` are AA-specific and should be omitted or set to null/blank for FIP and FIU.

### Template

> **Note**: The base JSON structure is identical for all RE types. The tabs below are provided for clarity — each view highlights the relevant fields and example values as applicable to that entity type (FIU, FIP, or AA).

{% tabs %}
{% tab title="FIU" %}

```json
{
  "ver": "1.0",
  "timestamp": "2026-03-18T08:04:50.314Z",
  "txnid": "407a70dd-88dd-423d-97a6-edbc0d0694da",
  "type": "FIU",
  "requester": {
    "name": "Sahamati FIU Test",
    "id": "sahamati-fiu-test-new"
  },
  "entityinfo": {
    "tags": "Sandbox",
    "name": "Sahamati FIU Test",
    "id": "sahamati-fiu-test-new",
    "code": "sahamati-fiu-test-new",
    "entityhandle": "",
    "Identifiers": [],
    "baseurl": "v2:https://data.sahamati.com/fiu/sahamati-test/v2",
    "webviewurl": null,
    "fitypes": [],
    "certificate": {
      "e": "AQAB",
      "n": "<RSA modulus here>",
      "alg": "RS256",
      "kid": "<key-id-uuid>",
      "kty": "RSA",
      "use": "sig"
    },
    "tokeninfo": {
      "url": "",
      "desc": ""
    },
    "gsp": null,
    "signature": {
      "signValue": ""
    },
    "inboundports": ["443"],
    "outboundports": ["443"],
    "ips": ["<ip-address>"]
  }
}

```

{% endtab %}

{% tab title="FIP" %}

<pre class="language-json"><code class="lang-json">{
  "ver": "1.0",
  "timestamp": "2026-03-18T08:04:50.314Z",
  "txnid": "407a70dd-88dd-423d-97a6-edbc0d0694da",
  "type": "FIP",
  "requester": {
    "name": "Sahamati FIP Test",
<strong>    "id": "sahamati-fip-test"
</strong>  },
  "entityinfo": {
    "tags": "Sandbox",
    "name": "Sahamati FIP Test",
    "id": "sahamati-fip-test",
    "code": "sahamati-fip-test",
    "entityhandle": "",
    "Identifiers": [
      { "category": "STRONG", "type": "MOBILE" },
      { "category": "STRONG", "type": "PAN" }
    ],
    "baseurl": "v2:https://data.sahamati.com/fip/sahamati-test/v2",
    "webviewurl": null,
    "fitypes": [
      "DEPOSIT", "TERM_DEPOSIT", "RECURRING_DEPOSIT", "SIP", "CP",
      "EQUITIES", "MUTUAL_FUNDS"
    ],
    "certificate": {
      "e": "AQAB",
      "n": "&#x3C;RSA modulus here>",
      "alg": "RS256",
      "kid": "&#x3C;key-id-uuid>",
      "kty": "RSA",
      "use": "sig"
    },
    "tokeninfo": {
      "url": "",
      "desc": ""
    },
    "gsp": null,
    "signature": {
      "signValue": ""
    },
    "inboundports": ["443"],
    "outboundports": ["443"],
    "ips": ["&#x3C;ip-address>"]
  }
}
</code></pre>

{% endtab %}

{% tab title="AA" %}

```json
{
  "ver": "1.0",
  "timestamp": "2026-03-18T08:04:50.314Z",
  "txnid": "407a70dd-88dd-423d-97a6-edbc0d0694da",
  "type": "AA",
  "requester": {
    "name": "Sahamati AA Test",
    "id": "sahamati-aa-test"
  },
  "entityinfo": {
    "tags": "Sandbox",
    "name": "Sahamati AA Test",
    "id": "sahamati-aa-test",
    "code": "sahamati-aa-test",
    "entityhandle": "@sahamati-aa-test",
    "Identifiers": [],
    "baseurl": "v2:https://data.sahamati.com/aa/sahamati-test/v2",
    "webviewurl": "https://webview.sahamati.com/aa/sahamati-test",
    "fitypes": [],
    "certificate": {
      "e": "AQAB",
      "n": "<RSA modulus here>",
      "alg": "RS256",
      "kid": "<key-id-uuid>",
      "kty": "RSA",
      "use": "sig"
    },
    "tokeninfo": {
      "url": "",
      "desc": ""
    },
    "gsp": null,
    "signature": {
      "signValue": ""
    },
    "inboundports": ["443"],
    "outboundports": ["443"],
    "ips": ["<ip-address>"]
  }
}

```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: 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:

```
GET https://developer.sahamati.org.in/how-to-guides/central-registry-json-template.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.