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.
To fetch the metadata of all the entities of a specific type (FIU or FIP or AA).
Authorizations
Path parameters
typestring · enumRequiredPossible values:
Type of entity
Responses
200
Successful retrieval
application/json
400
Schema validation failure
application/json
401
Unauthorized or Invalid token
404
Entity not found
application/json
get
GET /cr/v2/entityInfo/{type} HTTP/1.1
Host: api.sandbox.sahamati.org.in
Authorization: Bearer JWT
Accept: */*
{
"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"
]
}
}
To fetch the metadata of a specific entity by its type and ID
Authorizations
Path parameters
typestring · enumRequiredPossible values:
Type of entity
idstringRequired
Entity identifier
Responses
200
Successful retrieval
application/json
400
Schema validation failure
application/json
401
Unauthorized or Invalid token
404
Entity not found
application/json
get
GET /cr/v2/entityInfo/{type}/{id} HTTP/1.1
Host: api.sandbox.sahamati.org.in
Authorization: Bearer JWT
Accept: */*
{
"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"
]
}
}
API Collection:
Was this helpful?