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

Field / Parameter
Type
Required
Description
Example Value

ver

String

Required

Version of the API/schema being used.

2.0

timestamp

String (ISO 8601)

Required

UTC timestamp of the request in ISO 8601 format.

2026-03-18T08:04:50.314Z

txnid

String (UUID)

Required

Unique transaction ID for tracking this request.

407a70dd-88dd-423d-97a6-edbc0d0694da

type

String (Enum)

Required

Entity type being registered. One of: FIP, FIU, AA.

FIU

requester — Identifies the party submitting the request

Field / Parameter
Type
Required
Description
Example Value

requester.name

String

Required

Display name of the entity submitting the request.

Sahamati FIU Test

requester.id

String

Required

Unique ID of the requesting entity as registered in the CR.

sahamati-fiu-test-new

entityinfo — Core entity registration details

Field / Parameter
Type
Required
Description
Example Value

entityinfo.tags

String

Optional

Environment tag for the entity (e.g. Sandbox, Production).

Sandbox

entityinfo.name

String

Required

Name of the entity as submitted while listing itself in the CR.

Sahamati FIU Test

entityinfo.id

String

Required

Unique ID issued by the CR to the entity.

sahamati-fiu-test-new

entityinfo.code

String

Required

ID issued by the financial sector regulator governing this entity.

sahamati-fiu-test-new

entityinfo.entityhandle

String

AA only

Handle suffix for user profiles managed by the AA (e.g. @aa). Leave blank for FIU/FIP.

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

(Ignore for now)

Field / Parameter
Type
Required
Description
Example Value

gsp

Object | null

FIP only

GSP details when a gateway sits between AAs and the FIP (e.g. GSTN). Set to null for FIU/AA.

null

gsp.id

String

FIP only

ID issued to the GSP acting as FIP gateway.

FIPGSP000001

gsp.name

String

FIP only

Name of the GSP.

Some Services Pvt. Ltd

gsp.ip

String

FIP only

IP address AAs connect to for this GSP.

111.222.333.444

gsp.url

String

FIP only

URL AAs must whitelist for GSP endpoints.

https://example.com

entityinfo.tokeninfo — Token issuance details

(Ignore for now)

Field / Parameter
Type
Required
Description
Example Value

tokeninfo.url

String (URL)

Ignore

URL of the entity's Token Issuance Service. Reserved for future use.

https://.../tokens/

tokeninfo.desc

String

Ignore

Description field. Reserved for future use.

""

tokeninfo.maxcalls

Integer

Ignore

Max API calls limit. Reserved for future use.

1

entityinfo.signature — Request signature

(Ignore for now)

Field / Parameter
Type
Required
Description
Example Value

signature.signValue

String

Ignore

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

Last updated

Was this helpful?