CR APIs

Central Registry APIs

Fetching Regulated Entities REs metadata using Central Registry (CR)

A RE should fetch the metadata of the other REs to interact with them through ReBIT APIs to handle the AA ecosystem functionalities. Sahamati provided the CR APIs to access the REs metadata. Here is the sequence diagram for Fetching REs metadata.

Fetch REs Metadata using Central Registry

Get Entities by Type

get

To fetch the metadata of all the entities of a specific type (FIU or FIP or AA).

Authorizations

Path parameters

typestring · enumrequired

Type of entity

Options: FIU, FIP, AA

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sandbox.sahamati.org.in/cr/v2/entityInfo/{type}' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

200

{
  "ver": "1.0",
  "timestamp": "2024-10-16 08:04:50.314",
  "txnid": "1fbb-11ed-861d-0242",
  "requester": {
    "name": "text",
    "id": "text"
  },
  "entityinfo": {
    "name": "text",
    "id": "text",
    "code": "text",
    "entityhandle": "text",
    "Identifiers": [
      {
        "category": "text",
        "type": "text"
      }
    ],
    "baseurl": "text",
    "webviewurl": "text",
    "fitypes": [
      "text"
    ],
    "certificate": {
      "alg": "text",
      "e": "text",
      "kid": "text",
      "kty": "text",
      "n": "text",
      "use": "text"
    },
    "tokeninfo": {
      "url": "text",
      "desc": "text"
    },
    "inboundports": [
      "text"
    ],
    "outboundports": [
      "text"
    ],
    "ips": [
      "text"
    ]
  }
}

Successful retrieval

Get Entity by Type and ID

get

To fetch the metadata of a specific entity by its type and ID

Authorizations

Path parameters

typestring · enumrequired

Type of entity

Options: FIU, FIP, AA

idstringrequired

Entity identifier

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sandbox.sahamati.org.in/cr/v2/entityInfo/{type}/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

200

{
  "ver": "1.0",
  "timestamp": "2024-10-16 08:04:50.314",
  "txnid": "1fbb-11ed-861d-0242",
  "requester": {
    "name": "text",
    "id": "text"
  },
  "entityinfo": {
    "name": "text",
    "id": "text",
    "code": "text",
    "entityhandle": "text",
    "Identifiers": [
      {
        "category": "text",
        "type": "text"
      }
    ],
    "baseurl": "text",
    "webviewurl": "text",
    "fitypes": [
      "text"
    ],
    "certificate": {
      "alg": "text",
      "e": "text",
      "kid": "text",
      "kty": "text",
      "n": "text",
      "use": "text"
    },
    "tokeninfo": {
      "url": "text",
      "desc": "text"
    },
    "inboundports": [
      "text"
    ],
    "outboundports": [
      "text"
    ],
    "ips": [
      "text"
    ]
  }
}

Successful retrieval

API Collection:

4KB

Central Registry.postman_collection.json

Central Registry - API Collection