CERSAI2.0 - API Specifications Document - v1 - 6

CERSAI 2.
0 – API Specifications
Document
TATA Consultancy Services Ltd.

21 August, 2023
ver. 1.6
Suraj Prajapati
CERSAI 2.0 – API Specifications Document ver. 1.6
Copyright
The data, designs, flowcharts and ideas contained herein will not be disclosed, duplicated, or used in whole or in
part for any purpose other than to evaluate the proposal, provided that if a contract is awarded to this offer as a
result of, or in connection with, the submission of these data, the propose will have the right to duplicate, use or
disclose the data to the extent provided in the agreement.
All trademarks that appear in the document have been used for identification purposes only and belong to their
respective companies.
Tata Code of Conduct

Tata Consultancy Services Limited (TCS), in its dealings, is self-regulated by a Code of Conduct as enshrined in the
"Tata Code of Conduct". TCS requests that any violation or potential violation of the Code by any person be
promptly brought to the notice of the Local Ethics Counsellor or the Principal Ethics Counsellor or the MD of TCS.
All communication received in this regard will be treated and kept as confidential.
For any Queries: mail at tech@cersai.org.in with subject line UAT/PROD || API Integration || SI Registration || EntityCode.
Note: Modify the Subject line with your Entity Code and accoding to the environment you are using (UAT/PROD). Page 2 of 175
Document Revision History
Version No. Date Revision/Changes Author Reviewer
September Updated API Registration steps and Added API Vibha

1.6 Suraj Prajapati
01, 2023 Amendment Steps and Exceptions Details. Bhardwaj
July 18, Added Consortium and Movable Sample Manish Himanshu
1.5
2023 Requests and their responses Prajapati Gambhir
October Himanshu Uminder
1.4 Changes Related to API Version 1.01
18, 2022 Gambhir Khatri
March Added IV parameter (Aplicable Only for QA)and Himanshu Shivi
1.3
8,2022 Annexure II, Updated Request payload Gambhir Chhabra
January Vibha Vibha
1.2 Added HTML Decoding Format
24,2022 Bhardwaj Bhardwaj
September Changed some attributes with mandatory/non- Vibha Uminder
1.1
24,2021 mandatory status in Table 2 Bhardwaj Khatri
August 11, Vibha Uminder
1.0 Added Sample Requests and their responses
2021 Bhardwaj Khatri
June Uminder
0.6 Added decription of different types of assets NalinshayAneja
22,2021 Khatri
Added decription of different types of assets
March 05, Uminder
0.5 and different types of borrowers and asset NalinshayAneja
2021 khatri
owners
February Uminder
0.4 Parameter added in request payload NalinshayAneja
04, 2021 Khatri
December Uminder
0.3 Updated Request payload NalinshayAneja
22, 2020 Khatri
November Uminder
0.2 Steps added for registration of Security Interest NalinshayAneja
17, 2020 Khatri
October03, API SpecificationsDocument for CERSAI 2.0 – Sanjeev
0.1 (Draft) Uminder Khatri
2020 draft version. Kumar
Contents
........................................................................................................................................................................... 1
Copyright ............................................................................................................................................................ 2
Tata Code of Conduct ........................................................................................................................................ 2
Document Revision History ............................................................................................................................... 3
List of Abbreviation ............................................................................................................................................ 6
1. Introduction ........................................................................................................................................... 7
2. Pre-requisites ......................................................................................................................................... 8
3. Process Flow........................................................................................................................................... 9
Consuming the APIs ........................................................................................................................................... 9
4. Steps for Registration for API .............................................................................................................. 10
5. Steps for Amendment of API ............................................................................................................... 11
6. Registration of Security Interest API ................................................................................................... 13
URL ...................................................................................................................................................................13
API Request (Encrypted) ..................................................................................................................................13
API Request (Un-encrypted) ............................................................................................................................14
API Request Attributes .....................................................................................................................................18
API Response (Encrypted) ................................................................................................................................23
API Response (Un-encrypted) ..........................................................................................................................25
API Response Attributes ..................................................................................................................................28
API Server Side Validation Error Response (Encrypted) ..................................................................................29
API API Server Side Validation Error Response (Un-encrypted) ......................................................................30
API Response Attributes ..................................................................................................................................30
Annexure I: Sample Requests and Responses ................................................................................................ 32
Annexure II: Server-Side Validations – Security Interest Registration For Security Interest – .................. 130
Annexure III: Exception – Error Code and Description for Security Interest............................................... 174
List of Tables
Table 1: List of Abbreviations ....................................................................................................................................... 6
Table 2: Registration of Security Interest / Attachment Order API Request Attributes ............................................ 18
Table 3: Registration of Security Interest / Attachment Order API Response Attributes .......................................... 28
Table 4: Server Side Validation Error API Response Attributes .................................................................................. 30
Table 5: Field Validation for Security Interest .......................................................................................................... 130
Table 6: Field Validation for Attachment Order ....................................................................................................... 133
Table 7: Field Validation for Immovable Assets ....................................................................................................... 135
Table 8: Field Validation for Movable Assets ........................................................................................................... 142
Table 9: Field Validation for Intangible Assets ......................................................................................................... 147
Table 10: Field Validation for Borrowers .................................................................................................................. 153
Table 11: Field Validation for Asset Owner .............................................................................................................. 162
Table 12: Field Validation for Charge Holder ............................................................................................................ 170
Table 13: Field Validation for Consortium ................................................................................................................ 173
Table 14: Error Code and Description for Security Interest ..................................................................................... 174
List of Abbreviation
This section provides the details of the abbreviations used in the document.
Table 1: List of Abbreviations
Abbreviation Expanded Form

CERSAI Central Registry of Securitisation Asset Reconstruction and Security Interest of India
API Application Programming Interface
TCS Tata Consultancy Services Limited
MD Managing Director
Securitisation and Reconstruction of Financial Assets and Enforcement of Security
SARFAESI
Interest Act, 2002
PUA Primary User Administrator
RSA Rivest-Shamir-Adleman Assymetric encryption algorithm
REST Reprtesentational State Transfer
JSON Javascript Object Notation
AES Advanced Encryption Standard symmetric encryption algorithm
URL Uniform Resource Locator
PROD Production Environment
UAT User Acceptance Testing Environment
1. Introduction
Central Registry of Securitisation Asset Reconstruction and Security Interest of India (CERSAI) is a Government of
India company licensed under section 8 of the Companies Act, 2013 with Govt. of India having a shareholding of
51% by the Central Government and select Public Sector Banks and the National Housing Bank also being
shareholders of the Company. The objective of the company is to maintain and operate a Registration System for
the purpose of registration of transactions of securitization, asset reconstruction of financial assets and creation
of security interest over property, as contemplated under Chapter IV of the Securitization and Reconstruction of
Financial Assets and Enforcement of Security Interest (SARFAESI) Act, 2002.
To provide this mechanism, a web-based system was developed for registration of transaction by financial
institutions. It enables lenders and other stake holders to get real time current information regarding the
collateral being mortgaged by borrower which helps in preventing fraudulent transactions arising out of same
asset being mortgaged with multiple lenders. It also provides potential buyers of assets with information about
any encumbrances on the assets.
The functionalities and the end users of the Central Registry have increased steadily over a period of time since
the Central Registry was operationalised on 31st Mar 2011. CERSAI has developed certain APIs to cater to the
increased load on the Central Registry Portal as well as to provide a better end-user experience. This document
provides the specifications for the Security Interest registration API.
2. Pre-requisites
In order to consume the APIs exposed by CERSAI, the following pre-requisites must be fulfilled:
1. Consumer entity must be a registered entity in the Central Registry portal.

2. Consumer entity must have a valid class III digital signature.
3. Consumer entity will have to fill and submit the API Requisition Form. Only upon approval on the API Requisition Form
by CERSAI, the consumers will be able to consume the API.
4. Consumer entity must incorporate all the relevant master data required for consuming the APIs. The master data can
be downloaded from the ‘Downloads’ section of the CERSAI portal.
3. Process Flow
The process flow for consuming CERSAI 2.0 APIs is mentioned below:
1. Any entity that wants to consume the CERSAI APIs, will have to first fill an API registration form through the portal.
The PUA users of the entity will have the authorisation for filling this form.
2. A valid class III digital signature is required for performing this step. This digital signature will be required for signing all
the API requests and hence, need to be plugged in / present on the consuming server all the time.
3. After filling in the necessary details and selecting the digital signature, the PUA will submit the form. Upon submission,
the request will come to CERSAI admin users for approval.
4. After CERSAI admin user has successfully approved the request, the system will generate:
4.1. A new channel key. This channel key will be required to be passed in all API requests.
4.2. A new user Id and password, to be used exclusively for consuming the APIs.
4.3. A new RSA key pair. The public key will be shared with the institution while the private key will be maintained
in the system.
Consuming the APIs

1. For consuming any API, the consumer entity will have to first test the API in the non-production environment of
CERSAI. Only after successfully testing the API in the non-production environment, the production environment will be
enabled for the consumer entity.
2. All the APIs exposed by CERSAI will be REST APIs. The request and response payloads will be in JSON format.
3. Each API payload will be having two sections – ‘header’ and ‘body’.
4. The header section will contain the attributes related to authentication and authorisation of the API request.
5. The body section will further contain three main attributes – ‘additional info’ ,‘session key’ and ‘request payload’.
6. For consuming the APIs, first of all, the consuming system will have to digitally sign the SecurityInterestDetails Object
using the digital signature that was registered on the CERSAI portal while filling the API registration form and then
pass the signed value in RequestHash attribute of RequestPayload.
7. After SecurityInterestDetails is successfully digitally signed and RequestHash is created, a new unique AES256 session
key and 16-byte IV parameterwill have to be generated. The RequestPayload (containing SecurityInterestDetails and
Request hash) will then have to be encrypted using this session key and IV parameter.
8. The session key, IV parameter and password will have to be then encrypted using the public key shared with the entity
during the API registration process.
9. Encode the encrypted data to base-64 and invoke the API.
10. The response from CERSAI will only be encrypted using session key received in the API Request and encoded to base-
64.
4. Steps for Registration for API

4.1 Open URL:- https://www.qa.cersai.org.in/CERSAI/home.prg
4.2 Login using User ID and Password of Primary User Admin.
4.3 Once login, Under Menu option, Choose API/Batch registration under Entity Management Option.
4.4 Form will open, fill the required details (Password entered on the screen will be of API user and will be
used for every API request)
4.5 Click on Submit button once data is entered.
4.6 Pop-up for digital signature will appear where the user have to use different digital signature for the
registration process as this Digital Signature will be linked to the API user and will be used in every request to
digitally sign the payload of every request.
4.7 Once above steps will be done. You will get a system generated mail from our side, which include a
Channel Key, RSA Public Key and API User ID.
5. Steps for Amendment of API
5.1 OpenURL: -https://www.qa.cersai.org.in/CERSAI/home.prg
5.2 Login using User ID and Password of Primary User Admin.
5.3 Once login, Under Menu option, Choose API Amendment under Entity Management option.
5.4 Form will open, enter API Login Id which user had received on mail after successful API Registration
5.6 Form will open, Select the field which is you want to amend.
5.7 Once field is selected, form will open, if Password field is selected to amend.
5.8 Form will open, if all fields are selected to amend.
5.10 User will get the following message:
Your API has been amended Successfully and your Transaction ID is 20XXXXXXXX
6. Registration of Security Interest API

This section describes the API for registration of Security Interest / Attachment order transactions.
URL
The URL for the API will be shared separately with the approved entities.
API Request (Encrypted)

{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
"<<API User Password, create hash using SHA256, encrypt using pre-shared RSA public key,
base-64 encoded>>"
],
"UserType": "APIUSER",
"AuthenticationType": "AUTH_API"
}
},
"body": {
"AdditionalInfo": {
"EntityCode": "<<Consumer entity code, plain text>>",
"IV": "<<Create 16-byte IV parameter, Convert to String, encrypt using pre-shared RSA public key,
base-64 encoded>>"
},
"SessionKey": "<<Unique AES256 key, encryptusing pre-shared RSA public key, base-64 encoded >>",
"RequestPayload": "<<encrypt using AES256 session key and 16-byte IV parameter, base-64
encoded>>"
}
}
API Request (Un-encrypted)

{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
"<<API User Password, create hash using SHA256, encrypt using
pre-shared RSA public key, base-64 encoded>>"
],
}
},
"body": {
"AdditionalInfo": {
"IV": "<<Create 16-byte IV parameter, Convert to String, encrypt using
},
"SessionKey": "<<Unique AES256 key, encrypt using pre-shared RSA public key,
base-64 encoded >>",
"RequestPayload": {
"SecurityInterestDetails": {
"siHolder": {
"officeName": "Branch Name",
"siHolderAddress": {
"pincodeValue": "",
"pincode": 110036,
"districtCode": 124,
"countryCode": "IND",
"cityTownVillageCode": 2190,
"district": "",
"addressLine1": "Address Line One",
"addressLine2": "",
"stateCode": 10,
"addressLine3": "",
"cityTownVillage": ""
}
},
"borrowers": [
{
"isAssetOwner": false,
"address": {
"pincodeValue": "",
"pincode": 110036,
"district": "",
"addressLine1": "Address Line",
"addressLine2": "",
"stateCode": 10,
"addressLine3": "",
},
"individualCkyc": "",
"gender": "M",
"dob": "1984-04-12",
"mobile": "",
"individualName": "Borrower One",
"individualPan": "",
"fatherMotherName": "Father Name",
"type": "IND",
"email": ""
}
],
"securityInterest": {
"userIdentificationNumber": "IDENNO0001",
"totalSecuredAmount": "1000000",
"miscNarration": "",
"typeOfCharge": "Sample Charge",
"financingTypeId": 1,
"securityInterestCreationDate": "2020-09-18",
"securityInterestSubTypeId": 17,
"isRegistrationDedupBypassed": true
},
"asset": {
"assetCategoryDesc": "Immovables",
"assetSubTypeId": 1,
"assetTypeId": 1,
"assetCategoryId": 1,
"genericAsset": {
"bldgTowerNameNumber": "Building Name",
"area": "30",
"areaUnit": 1,
"pincode": 110086,
"houseFlatUnitNumber": "1006",
"srvyMncplNumber": "10002",
"prjctSchmSociety": "Project Name",
"strtNameNumber": "Street Name",
"pincodeValue": "",
"latlog1": "",
"latlog2": "",
"latlog3": "",
"latlog4": "",
"district": "",
"plotId": "1004",
"floorNumber": "7",
"stateCode": 10,
"lcltySector": "Sector Name",
"pocket": "",
"ctyTwnVillage": ""
},
"uniqueId": "",
"assetDesc": "Residential Plot",
"assetTypeOtherDesc": ""
},
"assetOwners": [
{
"address": {
"pincodeValue": "",
"pincode": 110039,
"district": "",
"addressLine1": "Address Line",
"addressLine2": "",
"stateCode": 10,
"addressLine3": "",
},
"gender": "M",
"dob": "1992-06-10",
"mobile": "",
"individualName": "Asset Owner One",
"type": "IND",
"email": ""
}
],
"transaction": {
"transactionTypeId": 8,
"processId": 1,
"omissionReason": "",
"omissionReasonCategory": "",
"transactionSubTypeId": 17,
"transactionMode": "A"
}
},
"RequestHash": "MIIGbwYJKoZIhvcNAQcCoIIGYDCCBlwCAQExCzAJBg /…/ QlmUoW9+f
/+JVQkw=="
}
}
}
Note:
Request hash : User needs to digitally sign the SecurityInterestDetails object using valid class III
Digital Signature to create the RequestHash.
API Request Attributes

Table 2: Registration of Security Interest / Attachment Order API Request Attributes
Sr. Attribute Name Data Is Remarks

No. Type Mandatory?
header
authinfo
1 LoginParams
1a APILOGIN Constant Yes Constant value: “APILOGIN”
1b API User Id String Yes API User Id
1c API User Password String Yes API Password
2 UserType Constant Yes Constant value: “APIUSER”
3 AuthenticationType Constant Yes Constant value: “AUTH_API”
body
4 AdditionalInfo
4a EntityCode String Yes CERSAI entity code
4b IV String Yes 16-byte IV parameter
5 SessionKey String Yes Unique AES256 key
RequestPayload
SecurityInterestDetails
siHolder
6 officeName String Yes Branch Name
siHolderAddress
7 pincodeValue Number No Not Applicable
8 Pincode ^ Number Yes Security Interest holder branch pin code
9 districtCode ^ Number Yes Security Interest holder branch district code
10 countryCode^ String Yes Security Interest holder branch country code
11 cityTownVillageCode^ Number Yes Security Interest holder branch sub district code
12 district String No Not Applicable
13 addressLine1 String Yes Security Interest holder branch address line 1
14 addressLine2 String No Security Interest holder branch address line 2
15 stateCode ^ Number Yes Security Interest holder branch state code
16 addressLine3 String No Security Interest holder branch address line 3
17 cityTownVillage String No Not Applicable
borrowers
18 isAssetOwner Boolean Yes i. When isAssetOwner : true , it implies borrower is asset
owner itself. Hence, there is no need to send details of asset
owner else user will get server side validation error in the
response.
ii. When isAssetOwner : false, it implies, borrower is not asset
owner. Hence, user needs to send asset owner details in asset
owner json else user will get server side validation error in the
response.

No. Type Mandatory?
address
20 pincode ^ Number Yes Borrower address pin code
21 districtCode ^ Number Yes Borrower address district code
22 countryCode ^ String Yes Borrower address country code
23 cityTownVillageCode ^ Number Yes Borrower address sub district code
25 addressLine1 String Yes Borrower address address line 1
26 addressLine2 String No Borrower address address line 2
27 stateCode ^ Number Yes Borrower address state code
28 addressLine3 String No Borrower address address line 3
30 pan String No Borrower’s PAN, applicable when borrower type =other than
Individual
31 ckyc String No Borrower’s CKYC, applicable when borrower type =other than
Individual
32 name String Conditional Borrower’s Name, mandatory when borrower type =other than
Individual
33 regNumber String Conditional Borrower’s Registration Number, mandatory when borrower
type =Indian Company / LLP
34 incorporationDate String Conditional Borrower’s Incorporation Date, mandatory when borrower
type =other than Individual
35 individualCkyc String No CKYC number of the borrower (individual)
36 Gender ^ String Conditional Mandatory when borrower type = Individual
37 Dob Date Conditional Borrower’s date of birth, mandatory when borrower type =
Individual
38 mobile String No Borrower’s mobile number
39 individualName String Conditional Borrower’s name, mandatory when borrower type = Individual
40 individualPan String No Borrower’s PAN, applicable when borrower type = Individual
41 fatherMotherName String Conditional Borrower’s father / mother’s name, mandatory when borrower
type = Individual
42 Type ^ String Yes Type of borrower
43 Email String No Borrower’s email
securityInterest
44 userIdentificationNumber String Yes Entity Identification Number
45 totalSecuredAmount Number Yes Total secured amount of the security interest
46 miscNarration String No Narration
47 typeOfCharge String Yes Type of charge the entity holds
48 financingTypeId ^ Number Yes Type of financing – Sole, Consortium or Multiple
49 securityInterestCreationDate Date Yes The security interest creation date within the bank
50 securityInterestSubTypeId ^ Number Yes Type of security interest
51 isRegistrationDedupBypassed String Yes i. isRegistrationDedupBypassed: false, it implies that system

No. Type Mandatory?
will search for 'Matching Assets', user will either get matching
assets or SI Registration will be successful if No Match is found.
ii. isRegistrationDedupBypassed: true, it implies that user
wants to bypass de duplication process i.e. system won't
search matching assets for entered asset details.
asset
52 assetCategoryDesc String No Not Applicable
53 assetSubTypeId ^ Number Conditional Asset Sub Type, dependent upon asset type
54 assetTypeId ^ Number Yes Type of Asset
55 assetCategoryId ^ Number Yes Category of Asset
56 assetDesc String Yes Description of the asset
57 assetTypeOtherDesc String Conditional Type of Asset descripton – Others, mandatory when type of
asset = Other(s)
genericAsset
58 bldgTowerNameNumber String No Name / number of the building, applicable when asset category
= immovable
59 area Number No Area of the asset, applicable when asset category is immovable
60 areaUnit ^ Number Conditional Unit of the Area, mandatory when area is provided
61 pincode ^ Number Conditional Pincode of the asset is mandatory when asset category is
immovable
62 houseFlatUnitNumber String Conditional House Number, dependent on asset type
63 districtCode ^ Number Conditional District code of the asset, mandatory when asset category is
immovable
64 srvyMncplNumber String Conditional Survey / Municipal number of the asset, dependent upon plot
number of the asset, applicable when asset categoryis
immovable
65 prjctSchmSociety String Conditional Name of the project / scheme / society, mandatory when asset
category = immovable
66 strtNameNumber String No Name / number of the street, applicable when asset category is
immovable
67 pincodeValue String No Not Applicable
68 latlog1 String No Lat – Long coordinates of the asset, applicable when asset
72 cityTownVillageCode ^ Number Conditional Sub district code of the asset, mandatory when asset category
is immovable
73 countryCode ^ Constant Conditional Constant Value: “IND”, mandatory when asset category is
immovable
75 plotId String Conditional Plot number of the asset, dependent upon Survey number,

No. Type Mandatory?
applicable when asset category = immovable
76 floorNumber Number Conditional Floor number of the asset, applicable when asset category =
immovable
77 stateCode ^ Number Conditional State code the asset, mandatory when asset category is
immovable
78 lcltySector String Conditional Name of the locality / sector of the asset, mandatory when
asset category = immovable
79 pocket String No Pocket of the asset, applicable when asset category =
immovable
80 ctyTwnVillage String No Not Applicable
81 uniqueId String No Not Applicable
82 make String Conditional applicable when asset category ID = 2 and asset type id=5
83 model String Conditional applicable when asset category ID = 2 and asset type id=5
84 serialNum String Conditional applicable when asset category ID = 2 and asset type id=5
85 patentDate Date Conditional applicable when asset category ID = 3 and asset type id= 9
86 diaryNumber String Conditional applicable when asset category ID = 3 and asset type id= 8
87 patentNumber String Conditional applicable when asset category ID = 3 and asset type id= 9
88 licenseNumber String Conditional applicable when asset category ID = 3 and asset type id= 10
89 copyrightClass String Conditional applicable when asset category ID = 3 and asset type id= 8
90 copyrightTitle String Conditional applicable when asset category ID = 3 and asset type id= 8
91 iprDesignClass String Conditional applicable when asset category ID = 3 and asset type id= 11
and 12
92 trmkApplNumber String Conditional applicable when asset category ID = 3 and asset type id= 13
93 iprDesignNumber String Conditional applicable when asset category ID = 3 and asset type id= 11
and 12
94 licenseCategory String Conditional applicable when asset category ID = 3 and asset type id= 10
95 licenseIssuingAuthority String Conditional applicable when asset category ID = 3 and asset type id= 10
96 trmkApplDate Date Conditional applicable when asset category ID = 3 and asset type id= 13
address This field is mandatory when asset type id =6 (inventory-
movable)
97 addressLine1 String Conditional address line1 of the asset, mandatory when asset type id =6 or
7 (inventory-movable or others-movable)
98 addressLine2 String No address line2 of the asset applicable when asset type id =6 or 7
(inventory-movable or others-movable)
99 addressLine3 String No address line 3 of the asset applicable when asset type id =6 or
7 (inventory-movable or others-movable)
100 pincode ^ Number Conditional pincode of the asset, mandatory when asset type id =6 or 7
101 districtCode ^ Number Conditional districtCode of the asset, mandatory when asset type id =6 or 7
102 cityTownVillageCode ^ Number Conditional cityTownVillageCodeof the asset, mandatory when asset type
id =6 or 7 (inventory-movable or others-movable)
103 countryCode ^ Constant Conditional countryCode of the asset, mandatory when asset type id =6 or
7(inventory-movable or others-movable)

No. Type Mandatory?
104 stateCode ^ Number Conditional stateCode of the asset, mandatory when asset type id =6 or
7(inventory-movable or others-movable)
assetOwners
address
106 pincode ^ Number Yes Asset owner address pin code
107 districtCode ^ Number Yes Asset owner address district code
108 countryCode ^ String Yes Asset owner address country code
109 cityTownVillageCode ^ Number Yes Asset owner address sub district code
111 addressLine1 String Yes Asset owner address address line 1
112 addressLine2 String No Asset owner address address line 2
113 stateCode ^ Number Yes Asset owner address state code
114 addressLine3 String No Asset owner address address line 3
116 pan String No Mandatory when asset owner type =other than Individual
117 ckyc String No Mandatory when asset owner type =other than Individual
118 name String Conditional Mandatory when asset owner type =other than Individual
119 regNumber String Conditional Mandatory when asset owner type = Indian Company / LLP
120 incorporationDate String Conditional Mandatory when asset owner type = Indian Company / LLP
121 individualCkyc String No CKYC number of the Asset owner (individual)
122 Gender ^ String Conditional Mandatory when Asset owner type = Individual
123 Dob Date Conditional Asset owner’s date of birth, mandatory when Asset owner type
= Individual
124 mobile String No Asset owner’s mobile number
125 individualName String Conditional Asset owner’s name, mandatory when Asset owner type =
Individual
126 individualPan String No Asset owner’s PAN, applicable when Asset owner type =
Individual
127 fatherMotherName String Conditional Asset owner’s father / mother’s name, mandatory when Asset
owner type = Individual
128 Type ^ String Yes Type of Asset owner
129 Email String No Asset owner’s email
transaction
130 transactionTypeId ^ Number Yes Type of transaction
131 processId Constant Yes Constant value: “1”
132 omissionReason String No Not Applicable
133 omissionReasonCategory String No Not Applicable
134 transactionSubTypeId ^ Number Yes Sub type of the transaction
135 transactionMode String Yes Constant Value: “A”
^: Values must be picked from the respective CERSAI masters.
API Response (Encrypted)

{
"header": {
"transactionId": "91pfj01XXXXXXXXXXXX010",
"status": "success"
},
"body": {
"APIResponse":"<<encrypted using the AES256 session key and
base-64 encoded>>"
}
}
Note:
If users receive response in html encoded format for eg.
{"header":{"transactionid":"haf3l01666166440144133&q
uot;,"status":"success"},"body":{"APIRespons
e":"HVB4a6lMVIIM83HzdvUfYEtyyTTXwkBOAJKQDgVNqP0Oe2ZULe+d3eb04ZJ44VJXTBFQ
jdnvMbJO2lmW4MMCmsRpDDghb2bltKhG7Jm5N7UikpcUgXGN2xMC/P29FBGYkxxy/o+53S5Wb
pMtxlFh1HDX7OttlyXVgTVwG5ryD0E3dkGHcCr0r2hp7efsfU6bFQti4/tTsTxDcFzG7uSG1WbV9zzMYj145TnFYI
/kuIHgyWpBCtogquXvr3Yw0YWsLHvyGNTVGbpLnloJwtJ0b+oH9slsnCfN/khKff0DO8XmXzwetAhQ
X3hl8SsazqF9GohROM2TrfEwu0q4ErJY5FbAm9qpd6OoXRAjPQyYKHf27YUe7BjkpXqrYxzN6FsFE6SrWwE2zfJsnSQV
SWmJLTHRIFWS+9gkwXjApp0gzhynk2L1EbowN+1Vh7C4t4/FnGh2oDohymPp/mqhXRZYlAe
Q6Cmk4SLw4IPPXzH6QmpibvmIdi/FejTI6EJXlgSlMoEYbXxg6W7F7+c+KrejGuBZl8KeIm5Y6JT8kO9
IPZ+k7XAzoGfIuEAs3T/gPeNZ8/OaaUM/s3OImE8hoVsEn5ktvJgLA8QCRghxTc9haaUHc9Y8vr
cfMzJfj0mr2Ofl2EMzxtrtVwhsd5ZZutm8KaDyZlJjDykSPZdPfqF54rGLb5FoZ6HrdJNf4aUMqCLJG2FOE9N7nGWNvxTy
/1lvNEw3xcwrcz//k22dQlSRRPydkClDQdQiAOX8Jb2+65qMaZAYtXIBrrYB726ft4mNkWukpw
mOk8qEY/yG2TAAxVcIkIPTlw7FvCRxF+7fW8bhchGNH5/LgLsqFhYx7Axq/9PM69lRal+
w24zP3q+2TWiBql8Er5jC9GOCNM7D6OU4OILnPruD8XXI9bGSuuZQfg=="}}
User needs to perform html decoding, if decrypted ‘APIResponse’ is received in above format.
Kindly include following line, in case user is using java:
StringEscapeUtils.unescapeHtml( “<Decrypted response in HTML encoded format>”);
API Response (Un-encrypted)

• API Response: De-Dup Status “NM”
{
"header": {
"transactionId": "91pfj01XXXXXXXXXXXX010",
"status": "success"
},
"body": {
"APIResponse": {
"transactionTypeId": null,
"matchingAssets": null,
"pgRequestMessage": null,
"transactionSubTypeIdOthers": null,
"transationStatus": "C",
"transactionId": 2001XXXXXX46,
"responseCode": null,
"transactionType": null,
"dedupStatus": "NM",
"additionalFeeAmount": null,
"transactionSubType": null,
"pgStatus": "NA",
"feeAmount": 100,
"securityInterestDetailsList": null,
"processId": null,
"processName": null,
"responseTimestamp": null,
"assetId": 2005XXXXXX57,
"tpslPaymentGateway": null,
"transactionSubTypeId": null,
"responseMessage": "Successful SI Registration",
"securityInterestId": 4010XXXXXX32
}
}
}
• API Response: De-Dup Status “MF”
{
"header": {
"transactionid": "mm0n1XXXXXXXXXXXXXXX10",
"status": "success"
},
"body": {
"APIResponse": {
"matchingAssets": [
{
"assetCategoryDesc": "Immovable",
"beaconFlag": true,
"assetTypeId": 1,
"borrowers": null,
"assetSubTypeOtherDesc": "Structure with Land",
"genericAsset": {
"areaUnit": "6",
"pincodeValue": null,
"isDeleted": false,
"stateName": null,
"assetId": 20XXXXXXXX95,
"plotId": "10004",
"floorNumber": "3",
"creationTimestamp": "2020-11-27 08:08:47.000",
"modifiedBy": null,
"lcltySector": "Locality",
"isDisabled": false,
"area": 1250,
"pincode": 110027,
"assetDescription": "Residential Plot",
"transactionId": 20XXXXXXXX11,
"latlog1": null,
"latlog2": null,
"latlog3": null,
"latlog4": null,
"createdBy": "M0XXXXXX15",
"district": null,
"stateCode": "10",
"modifiedTimestamp": null,
"countryName": null,
"pocket": null,
"ctyTwnVillage": null
},
"matchingPercentage": 100,
"securityInterest": null,
"assetTypeOtherDesc": "Residential",
"assetSubTypeDesc": "Structure with Land",
"isDeleted": false,
"assetTypeDesc": "Residential",
"modifiedBy": null,
"uniqueId": "",
"beaconCount": 0,
"assetDesc": null
}
],
"transationStatus": null,
"dedupStatus": "MF",
"pgStatus": null,
"feeAmount": 1,
"processId": null,
"assetId": null,
"responseMessage": null,
"securityInterestId": null
}
}
}
Note:
• In case of dedupstatus = “NM”, no further action is required at users end.
• In case of dedupstatus = “MF”
o You can either select the asset from matching asset list and can invoke Service II (Dedup API) with
dedupstatus = “S” or
o You can set dedupstatus = “F” to forcefully register your asset while invoking Service II (Dedup API)
API Response Attributes

Table 3: Registration of Security Interest / Attachment Order API Response Attributes
Sr. Is
Attribute Name Data Type Remarks
No. Mandatory?
Sr. Is
No. Mandatory?
header
1 transactionid String Yes CERSAI Request transaction Id
2 Status String Yes Status of the API request
body
3 transactionTypeId Number No Not Applicable
4 matchingAssets JSON Conditional List of Matching Assets
5 pgRequestMessage String No Not Applicable
6 transactionSubTypeIdOthers String No Not Applicable
7 transationStatus String Yes Status of the Security Interest transaction
8 transactionId Number Yes Security Interest registration transaction Id
9 responseCode String No Not Applicable
10 transactionType String No Not Applicable
11 dedupStatus String Conditional Deduplication status
12 additionalFeeAmount Number No Not Applicable
13 transactionSubType String No Not Applicable
14 pgStatus String No Not Applicable
15 feeAmount Number No Transaction fee amount
16 securityInterestDetailsList JSON No Not Applicable
17 processId Number No Not Applicable
18 processName String No Not Applicable
responseTimestamp Timestam
19 No Transaction response timestamp
p
20 assetId Number Conditional Asset Id in case of successful registration
21 tpslPaymentGateway String No Not Applicable
22 transactionSubTypeId Number No Not Applicable
23 responseMessage String Yes SI Registration response message
24 securityInterestId Number Conditional SI Id in case of successful registration
API Server Side Validation Error Response (Encrypted)

{
"header": {
"errorMessage": "Server Side Validation Error in SI Registration",
"errorCode": "21001",
"transactionid": "zvkwo01666172843171133",
"status": "error",
"errorDetails": "{\"Failure\":\"{\\\"APIResponse\\\":\\\"<<encrypted using
the AES256 session key and base-64 encoded>>\\\"}\"}"
}
}
API API Server Side Validation Error Response (Un-encrypted)

{
"header": {
"errorMessage": "Server Side Validation Error in SI Registration",
"errorCode": "21001",
"transactionid": "zvkwo01666172843171133",
"status": "error",
"errorDetails": "{\"Failure\":\"{\\\"APIResponse\\\":\\\"{"securityInterest":
{"miscNarration": "Consecutive special characters / spaces not allowed|Specia
l characters and spaces not allowed in beginning and end"},"asset":{"assetDes
c": "Consecutive special characters / spaces not allowed|Special characters a
nd spaces not allowed in beginning and end","genericAsset" :{"copyrightTitle"
: "Only alpha numeric characters with Hyphen / Underscore / Dot / Comma / For
ward Slash / Whitespace are allowed|Consecutive special characters / spaces n
ot allowed"}},"borrowers":[{"fatherMotherName": "Consecutive special characte
rs / spaces not allowed","address" :{"addressLine1": "Consecutive special cha
racters / spaces not allowed"},"borSerialNo":1}],"siHolder":{"officeName": "S
pecial characters and spaces not allowed in beginning and end","address" :{"a
ddressLine1": "Consecutive special characters / spaces not allowed|Special ch
aracters and spaces not allowed in beginning and end"}}}\\\"}\"}"
}
}
API Response Attributes

Table 4: Server Side Validation Error API Response Attributes
Sr. Is
No. Mandatory?
header
Sr. Is
No. Mandatory?
1 errorMessage String Yes CERSAI API Error Message
errorCode Status of the API request (21001 For Server Side
2 String Yes
Validation Error in Security Interest Registration API)
3 transactionid String Yes CERSAI Request transaction Id
4 Status String Yes Status of the API request
5 errorDetails String Yes Detailed Error Message.
Annexure I: Sample Requests and Responses
Assets in CERSAI system are categorised into three main categories:
• Immovable Assets
• Movable Assets
• Intangible Assets
Depending upon the type of Asset, these three categories are further sub-classified into 14 following sub-
categories of assets:
Immovable Assets
1. Residential
2. Commercial
3. Other
Movable Assets
4. Vehicle (now suppressed)

5. Equipment and Machinery
6. Inventory (incl Receivables)
7. Other
Intangible Assets
8. Copyright
9. Patent
10. Licence
11. Intellectual Property Right
12. Design
13. Trademark
14. Other
Different asset sub-types have different attributes, especially in Movables and Intangibles category of Assets. This
section provides the sample request (unencrypted) and their corresponding response (unencrypted) for each
asset sub-type.
• Asset Sub-Type: Residential (Immovable Assets)
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
],
}
},
"body": {
"AdditionalInfo": {
},
"RequestPayload": {
"asset": {
"uniqueId": "",
"assetDesc": "Residential Plot",
"assetTypeId": 1,
"genericAsset": {
"plotId": "",
"pocket": "",
"latlog1": "90 180",
"latlog2": "90 180",
"latlog3": "90 180",
"latlog4": "90 180",
"pincode": 382325,
"areaUnit": "",
"district": "Gandhinagar",
"stateCode": "12",
"stateName": "Gujarat",
"floorNumber": "",
"lcltySector": "Sector 786",
"ctyTwnVillage": "NANA CHILODA",
"strtNameNumber": "",
"srvyMncplNumber": "SampleSurvey",
"prjctSchmSociety": "gokuldham",
"bldgTowerNameNumber": "",
"houseFlatUnitNumber": "HouseNo3"
},
"assetSubTypeOtherDesc": "Structure with Land"
},
"borrowers": [
{
"address": {
"addressLine2": "Address Line Two",
"addressLine3": "Address Line Three",
"cityTownVillage": "",
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
"cityTownVillageCode": 2191
},
"gender": "M",
"dob": "1976-07-14",
"mobile": "",
"individualName": "Borrower Name",
"email": "",
"type": "IND"
}
],
"assetOwners": [
{
"address": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
"countryCode": "IND"
},
"gender": "M",
"dob": "1996-06-10",
"mobile": "",
"individualName": "Asset Owner Name",
"email": "",
"type": "IND"
}
],
"siHolder": {
"officeName": "Office Name",
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110001,
"pincodeValue": "",
}
},
"transaction": {
"processId": 1,
},
"userIdentificationNumber": "IDEXXXXXX14",
"miscNarration": "Narration",
"typeOfCharge": "First Charge",
"isRegistrationDedupBypassed": false
}
},
"RequestHash": "MIIGbwYJKoZIhvcNAQcCoIIGYDCCBlwCAQExCzAJBg /…/ QlmUoW9+f/
+JVQkw=="
}
}
}
Response:
{
"header": {
"status": "success"
},
"body": {
"APIResponse": {
"matchingAssets": [
{
"beaconFlag": true,
"assetTypeId": 1,
"borrowers": null,
"genericAsset": {
"areaUnit": "6",
"pincodeValue": null,
"isDeleted": false,
"stateName": null,
"plotId": "10004",
"floorNumber": "3",
"modifiedBy": null,
"lcltySector": "Locality",
"area": 1250,
"pincode": 110027,
"latlog1": null,
"latlog2": null,
"latlog3": null,
"latlog4": null,
"district": null,
"stateCode": "10",
"countryName": null,
"pocket": null,
"ctyTwnVillage": null
},
"securityInterest": null,
"isDeleted": false,
"modifiedBy": null,
"uniqueId": "",
"beaconCount": 0,
"assetDesc": null
}
],
"pgStatus": null,
"feeAmount": 1,
"processId": null,
"assetId": null,
}
}
}
• Asset Sub-Type: Commercial (Immovable Assets)
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
],
}
},
"body": {
"AdditionalInfo": {
},
"RequestPayload": {
"asset": {
"uniqueId": "",
"assetDesc": "aaaaa",
"assetTypeId": 2,
"genericAsset": {
"area": 11,
"plotId": "11",
"pocket": "",
"latlog1": "90 180",
"latlog2": "90 180",
"latlog3": "90 180",
"latlog4": "90 180",
"pincode": 822118,
"areaUnit": "2",
"district": "Palamau",
"stateCode": "16",
"stateName": "Jharkhand",
"floorNumber": "1",
"lcltySector": "1",
"ctyTwnVillage": "Chainpur",
"strtNameNumber": "11",
"prjctSchmSociety": "111",
"houseFlatUnitNumber": "11"
},
"assetTypeDesc": "Commercial",
"assetTypeOtherDesc": "Commercial",
},
"borrowers": [
{
"address": {
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1976-07-14",
"mobile": "",
"email": "",
"type": "IND"
}
],
"assetOwners": [
{
"address": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1996-06-10",
"mobile": "",
"email": "",
"type": "IND"
}
],
"siHolder": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110001,
"pincodeValue": "",
}
},
"transaction": {
"processId": 1,
},
}
},
+JVQkw=="
}
}
}
Response:
{
"header": {
"status": "success"
},
"body": {
"APIResponse": {
"MatchingAssets": [
{
"uniqueId": "",
"createdBy": "A0XXXXXX40",
"isDeleted": false,
"beaconFlag": true,
"assetTypeId": 2,
"beaconCount": 0,
"genericAsset": {
"area": 11,
"plotId": "11",
"assetId": 20XXXXXXXXX39,
"pincode": 822118,
"areaUnit": "2",
"isDeleted": false,
"stateCode": "16",
"floorNumber": "1",
"lcltySector": "1",
"assetDescription": "aaaaa",
},
},
{
"uniqueId": "",
"isDeleted": false,
"beaconFlag": true,
"assetTypeId": 2,
"beaconCount": 0,
"genericAsset": {
"area": 11,
"plotId": "11",
"assetId": 200XXXXXXX38,
"pincode": 822118,
"areaUnit": "2",
"isDeleted": false,
"stateCode": "16",
"floorNumber": "1",
"lcltySector": "1",
"transactionId": 20XXXXXXXXX80,
"assetDescription": "aaaaa",
},
}
],
"pgStatus": null,
"feeAmount": 1,
"processId": null,
"assetId": null,
}
}
}
• Asset Sub-Type: Other (Immovable Assets)
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
],
}
},
"body": {
"AdditionalInfo": {
},
"RequestPayload": {
"asset": {
"uniqueId": "",
"assetDesc": "Desc asset other",
"assetTypeId": 3,
"genericAsset": {
"area": 657,
"plotId": "876",
"pocket": "",
"latlog1": "90 180",
"latlog2": "90 180",
"latlog3": "90 180",
"latlog4": "90 180",
"pincode": 784510,
"areaUnit": "3",
"district": "Darrang",
"stateCode": "4",
"stateName": "Assam",
"floorNumber": "",
"districtCode": 37,
"ctyTwnVillage": "Harisinga",
"srvyMncplNumber": "SXXXX3",
"prjctSchmSociety": "Cersai",
"houseFlatUnitNumber": ""
},
"assetTypeDesc": "Other",
"assetSubTypeDesc": "Structure without Land",
"assetTypeOtherDesc": "Other",
"assetSubTypeOtherDesc": "Structure without Land"
},
"borrowers": [
{
"address": {
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1976-07-14",
"mobile": "",
"email": "",
"type": "IND"
}
],
"assetOwners": [
{
"address": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1996-06-10",
"mobile": "",
"email": "",
"type": "IND"
}
],
"siHolder": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110001,
"pincodeValue": "",
}
},
"transaction": {
"processId": 1,
},
}
},
+JVQkw=="
}
}
}
Response:
{
"header": {
"status": "success"
},
"body": {
"APIResponse": {
"matchingAssets": [
{
"uniqueId": "",
"createdBy": "B0XXXXXXX01",
"isDeleted": false,
"beaconFlag": true,
"assetTypeId": 3,
"beaconCount": 0,
"genericAsset": {
"area": 657,
"plotId": "876",
"pincode": 784510,
"areaUnit": "3",
"createdBy": " B0XXXXXXX01",
"isDeleted": false,
"stateCode": "4",
"districtCode": 37,
"transactionId": 200XXXXXXX38,
"srvyMncplNumber": "SNXX23",
"assetDescription": "Desc asset other",
},
}
],
"pgStatus": null,
"feeAmount": 1,
"processId": null,
"assetId": null,
}
}
}
• Asset Sub-Type: Equipment and Machinery (Movable Assets)
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
],
}
},
"body": {
"AdditionalInfo": {
},
"RequestPayload": {
"asset": {
"assetDesc": "TFTHRESHER",
"assetTypeId": 5,
"genericAsset": {
"make": "AGRIIMPL",
"model": "THRESHER",
"serialNum": "SRT6300"
},
"assetTypeDesc": "Equipment and Machinery",
"assetCategoryDesc": "Movable",
"assetTypeOtherDesc": "Equipment and Machinery"
},
"borrowers": [
{
"address": {
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1976-07-14",
"mobile": "",
"email": "",
"type": "IND"
}
],
"assetOwners": [
{
"address": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1996-06-10",
"mobile": "",
"email": "",
"type": "IND"
}
],
"siHolder": {

"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110001,
"pincodeValue": "",
}
},
"transaction": {
"processId": 1,
"transactionMode":"A"
},
}
},
+JVQkw=="
}
}
}
Response:
{
"header": {
"status": "success"
},
"body": {
"APIResponse": {
"matchingAssets": [
{
"createdBy": " B0XXXXXX89",
"isDeleted": false,
"beaconFlag": true,
"assetTypeId": 5,
"beaconCount": 0,
"genericAsset": {
"make": "AGRIIMPL",
"createdBy": "B0XXXXXX89",
"isDeleted": false,
"serialNum": "SRT6313",
"assetDescription": "TFTHRESHER",
"creationTimestamp": "2021-06-01 11:21:29.0"
},
"transactionId": 20XXXXXXXXXX9,
"assetTypeOtherDesc": "Equipment and Machinery",
"matchingPercentage": 100
},
{
"isDeleted": false,
"beaconFlag": true,
"assetTypeId": 5,
"beaconCount": 0,
"genericAsset": {
"make": "AGRIIMPL",
"createdBy": "B00XXXXX1",
"isDeleted": false,
"serialNum": "127",
"assetDescription": "TXXXXESER",

},
"assetTypeOtherDesc": "Equipment and Machinery",
}
],
"pgStatus": null,
"feeAmount": 1,
"processId": null,
"assetId": null,
}
}
}
• Asset Sub-Type: Inventory incl. Receivables (Movable Assets)
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
],
}
},
"body": {
"AdditionalInfo": {
},
"RequestPayload": {
"asset": {
"assetDesc": "InventReceivables",
"assetTypeId": 6,
"genericAsset": {
"address": {
"country": "India",
"pincode": 792103,
"district": "Changlang",
"stateCode": "3",
"stateName": "Arunachal Pradesh",
"addressLine1": "Address one asd",
"addressLine2": "",
"addressLine3": "",
"districtCode": 19,
"cityTownVillage": "Diyun Circle",
},
"serialNum": ""
},
"assetTypeDesc": "Inventory (incl Receivables)",
"assetTypeOtherDesc": "Inventory (incl Receivables)"
},
"borrowers": [
{
"address": {
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1976-07-14",
"mobile": "",
"email": "",
"type": "IND"
}
],
"assetOwners": [
{
"address": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1996-06-10",
"mobile": "",
"email": "",
"type": "IND"
}
],
"siHolder": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110001,
"pincodeValue": "",
}
},
"transaction": {
"processId": 1,
},
}
},
+JVQkw=="
}
}
}
Response:
{
"header": {
"status": "success"
},
"body": {
"APIResponse": {
"matchingAssets": [
{
"isDeleted": false,
"beaconFlag": true,
"assetTypeId": 6,
"beaconCount": 0,
"genericAsset": {
"address": {
"country": "India",
"pincode": 792103,
"district": "Changlang",
"addressId": 97984163,
"isDeleted": false,
"stateCode": "3",
"stateName": "Arunachal Pradesh",
"addressLine1": "Address one asd",
"addressLine2": "",
"addressLine3": "",
"districtCode": 19,
"cityTownVillage": "Diyun Circle",
},
"isDeleted": false,
"assetAddressId": 97984163,
"assetDescription": "InventReceivables",
},
"assetTypeOtherDesc": "Inventory (incl Receivables)",
}
]
"pgStatus": null,
"feeAmount": 1,
"processId": null,
"assetId": null,
}
}
}
• Asset Sub-Type: Other (Movable Assets)
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
],
}
},
"body": {
"AdditionalInfo": {
},
"RequestPayload": {
"asset": {
"assetDesc": "STOCK",
"assetTypeId": 7,
"genericAsset": {
"address": {
"country": "India",
"pincode": 444108,
"district": "Akola",
"stateCode": "21",
"stateName": "Maharashtra",
"addressLine1": "MAIN ROAD",
"addressLine2": "SHETKI WASTU BHANDAR",
"addressLine3": "",
"cityTownVillage": "Telhara",
},
"serialNum": ""
},
"assetTypeOtherDesc": "Other"
},
"borrowers": [
{
"address": {
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1976-07-14",
"mobile": "",
"email": "",
"type": "IND"
}
],
"assetOwners": [
{
"address": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1996-06-10",
"mobile": "",
"email": "",
"type": "IND"
}
],
"siHolder": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110001,
"pincodeValue": "",
}
},
"transaction": {
"processId": 1,
},
"userIdentificationNumber": "IDENNO00020",
}
},
+JVQkw=="
}
}
}
Response:
{
"header": {
"status": "success"
},
"body": {
"APIResponse": {
"matchingAssets": [
{
"createdBy": " A0XXXXXX0",
"isDeleted": false,
"beaconFlag": true,
"assetTypeId": 7,
"beaconCount": 0,
"genericAsset": {
"address": {
"country": "India",
"pincode": 444108,
"district": "Akola",
"addressId": 109663108,
"isDeleted": false,
"stateCode": "21",
"addressLine1": "MAIN ROAD",
"addressLine2": "SHETKI WASTU BHANDAR",
"addressLine3": "",
"cityTownVillage": "Telhara",
},
"isDeleted": false,
"assetAddressId": 10XXXXX08,
"assetDescription": "STOCK",
},
}
],
"pgStatus": null,
"feeAmount": 1,
"processId": null,
"assetId": null,
}
}
}
• Asset Sub-Type: Copyright (Intangible Assets)
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
],
}
},
"body": {
"AdditionalInfo": {
},
"RequestPayload": {
"asset": {
"uniqueId": "",
"assetDesc": "COPYRIGHT OTHERS AD",
"assetTypeId": 8,
"genericAsset": {
"serialNum": "1001 ASNO",
"diaryNumber": "1001 DA",
"patentNumber": "",
"licenseNumber": "",
"copyrightClass": "1001 AC",
"copyrightTitle": "Mira Asset Title",
"iprDesignClass": "",
"trmkApplNumber": "",
"licenseCategory": "",
"licenseIssuingAuthority": ""
},
"assetTypeDesc": "Copyright",
"assetCategoryDesc": "Intangible",
"assetTypeOtherDesc": "Copyright"
},
"borrowers": [
{
"address": {
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1976-07-14",
"mobile": "",
"email": "",
"type": "IND"
}
],
"assetOwners": [
{
"address": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1996-06-10",
"mobile": "",

"email": "",
"type": "IND"
}
],
"siHolder": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110001,
"pincodeValue": "",
}
},
"transaction": {
"processId": 1,
},
"securityInterestSubTypeOthers": "Security Interest Description",
}
},
+JVQkw=="
}
}
}
Response:
{
"header": {
"status": "success"
},
"body": {
"APIResponse": {
"matchingAssets": [
{
"uniqueId": "",
"isDeleted": false,
"beaconFlag": true,
"assetTypeId": 8,
"beaconCount": 0,
"genericAsset": {
"createdBy": "B0XXXXX001",
"isDeleted": false,
"serialNum": "1001 ASNO",
"diaryNumber": "1001 DA",
"copyrightClass": "1001 AC",
"copyrightTitle": "Mira Asset Title",
},
"assetTypeDesc": "Copyright",
"assetTypeOtherDesc": "Copyright",
}
],
"pgStatus": null,
"feeAmount": 1,
"processId": null,
"assetId": null,
}
}
}
• Asset Sub-Type: Patent (Intangible Assets)
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
],
}
},
"body": {
"AdditionalInfo": {
},
"RequestPayload": {
"asset": {
"assetDesc": "Patent",
"assetTypeId": 9,
"genericAsset": {
"patentDate": "2021-05-20",
"patentNumber": "PN323"
},
"assetTypeDesc": "Patent",
"assetTypeOtherDesc": "Patent"
},
"borrowers": [
{
"address": {
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1976-07-14",
"mobile": "",
"email": "",
"type": "IND"
}
],
"assetOwners": [
{
"address": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1996-06-10",
"mobile": "",
"email": "",
"type": "IND"
}
],
"siHolder": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110001,
"pincodeValue": "",
}
},
"transaction": {
"processId": 1,
},
}
},
+JVQkw=="
}
}
}
Response:
{
"header": {
"status": "success"
},
"body": {
"APIResponse": {
"matchingAssets": [
{
"uniqueId": "",
"isDeleted": false,
"beaconFlag": true,
"assetTypeId": 9,
"beaconCount": 0,
"genericAsset": {
"assetDesc": "PATENT",
"createdBy": "BXXXXXXX1",
"isDeleted": false,
"patentDate": "2020-02-24",
"patentNumber": "12345",
},
"assetTypeDesc": "Patent",
"assetTypeOtherDesc": "Patent",
}
],
"pgStatus": null,
"feeAmount": 1,
"processId": null,
"assetId": null,
}
}
}
• Asset Sub-Type: Licence (Intangible Assets)
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
],
}
},
"body": {
"AdditionalInfo": {
},
"RequestPayload": {
"asset": {
"assetDesc": "asdsd",
"assetTypeId": 10,
"genericAsset": {
"licenseNumber": "qs",
"licenseCategory": "as",
"licenseIssuingAuthority": "qasd"
},
"assetTypeDesc": "Licence",
"assetTypeOtherDesc": "Licence"
},
"borrowers": [
{
"address": {
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1976-07-14",
"mobile": "",
"email": "",
"type": "IND"
}
],
"assetOwners": [
{
"address": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1996-06-10",
"mobile": "",
"email": "",
"type": "IND"
}
],
"siHolder": {

"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110001,
"pincodeValue": "",
}
},
"transaction": {
"processId": 1,
},
}
},
+JVQkw=="
}
}
}
Response:
{
"header": {
"status": "success"
},
"body": {
"APIResponse": {
"matchingAssets": [
{
"isDeleted": false,
"beaconFlag": true,
"assetTypeId": 10,
"beaconCount": 0,
"genericAsset": {
"assetDesc": "asdsd",
"isDeleted": false,
"licenseNumber": "qs",
"licenseCategory": "as",
"licenseIssuingAuthority": "qasd"
},
"assetTypeDesc": "Licence",
"transactionId": 200204179010,
"assetTypeOtherDesc": "Licence",
}
],
"pgStatus": null,
"feeAmount": 1,
"processId": null,
"assetId": null,
}
}
}
• Asset Sub-Type: Intellectual Property Right (Intangible Assets)
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
],
}
},
"body": {
"AdditionalInfo": {
},
"RequestPayload": {
"asset": {
"assetDesc": "IPR INt 24",
"assetTypeId": 11,
"genericAsset": {
"iprDesignClass": "asdjkqkwei",
"iprDesignNumber": "DN asqwe"
},
"assetTypeDesc": "Intellectual Property Right ",
"assetTypeOtherDesc": "Intellectual Property Right "
},
"borrowers": [
{
"address": {
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1976-07-14",
"mobile": "",
"email": "",
"type": "IND"
}
],
"assetOwners": [
{
"address": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1996-06-10",
"mobile": "",
"email": "",
"type": "IND"
}
],
"siHolder": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110001,
"pincodeValue": "",
}
},
"transaction": {
"processId": 1,
},
}
},
+JVQkw=="
}
}
}
Response:
{
"header": {
"status": "success"
},
"body": {
"APIResponse": {
"matchingAssets": [
{
"isDeleted": false,
"beaconFlag": true,
"assetTypeId": 11,
"beaconCount": 0,
"genericAsset": {
"assetDesc": "IPR INt 24",
"isDeleted": false,
"iprDesignClass": "asdjkqkwei",
"iprDesignNumber": "DN asqwe",
},
"assetTypeDesc": "Intellectual Property Right ",
"assetTypeOtherDesc": "Intellectual Property Right ",
}
],
"pgStatus": null,
"feeAmount": 1,
"processId": null,
"assetId": null,
}
}
}
• Asset Sub-Type: Design (Intangible Assets)
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
],
}
},
"body": {
"AdditionalInfo": {
},
"RequestPayload": {
"asset": {
"assetDesc": "Design description asdqwe123",
"assetTypeId": 12,
"genericAsset": {
"iprDesignClass": "CLASS1232dqwe",
"iprDesignNumber": "DN12asd123"
},
"assetTypeDesc": "Design",
"assetTypeOtherDesc": "Design"
},
"borrowers": [
{
"address": {
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1976-07-14",
"mobile": "",
"email": "",
"type": "IND"
}
],
"assetOwners": [
{
"address": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1996-06-10",
"mobile": "",
"email": "",
"type": "IND"
}
],
"siHolder": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110001,
"pincodeValue": "",
}
},
"transaction": {
"processId": 1,
},
}
},
+JVQkw=="
}
}
}
Response:
{
"header": {
"status": "success"
},
"body": {
"APIResponse": {
"matchingAssets": [
{
"isDeleted": false,
"beaconFlag": true,
"assetTypeId": 12,
"beaconCount": 0,
"genericAsset": {
"assetDesc": "Design description asdqwe123",
"isDeleted": false,
"iprDesignClass": "CLASS1232dqwe",
"iprDesignNumber": "DN12asd123",
},
"assetTypeDesc": "Design",
"assetTypeOtherDesc": "Design",
}
],
"pgStatus": null,
"feeAmount": 1,
"processId": null,
"assetId": null,
}
}
}
• Asset Sub-Type: Trademark (Intangible Assets)
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
],
}
},
"body": {
"AdditionalInfo": {
},
"RequestPayload": {
"asset": {
"assetDesc": "desc trade",
"assetTypeId": 13,
"genericAsset": {
"serialNum": "",
"diaryNumber": "",
"patentNumber": "",
"trmkApplDate": "2008-06-14",
"licenseNumber": "",
"copyrightClass": "",
"copyrightTitle": "",
"iprDesignClass": "",
"trmkApplNumber": "ahgj123",
"iprDesignNumber": "",
"licenseCategory": "",
"licenseIssuingAuthority": ""
},
"assetTypeDesc": "Trade-Mark",
"assetTypeOtherDesc": "Trade-Mark"
},
"borrowers": [
{
"address": {
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1976-07-14",
"mobile": "",
"email": "",
"type": "IND"
}
],
"assetOwners": [
{
"address": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1996-06-10",
"mobile": "",

"email": "",
"type": "IND"
}
],
"siHolder": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110001,
"pincodeValue": "",
}
},
"transaction": {
"processId": 1,
},
}
},
+JVQkw=="
}
}
}
Response:
{
"header": {
"status": "success"
},
"body": {
"APIResponse": {
"matchingAssets": [
{
"isDeleted": false,
"beaconFlag": true,
"assetTypeId": 13,
"beaconCount": 0,
"genericAsset": {
"assetDesc": "desc trade",
"isDeleted": false,
"trmkApplDate": "2008-06-14",
"trmkApplNumber": "ahgj123",
},
"assetTypeDesc": "Trade-Mark",
"assetTypeOtherDesc": "Trade-Mark",
}
],
"pgStatus": null,
"feeAmount": 1,
"processId": null,
"assetId": null,
}
}
}
• Asset Sub-Type: Other (Intangible Assets)
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
],
}
},
"body": {
"AdditionalInfo": {
},
"RequestPayload": {
"asset": {
"assetDesc": "Hypo of Cash Flow and Receivables",
"assetTypeId": 14,
"genericAsset": {
"serialNum": "39802775843"
},
"assetTypeOtherDesc": "Other"
},
"borrowers": [
{
"address": {
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1976-07-14",
"mobile": "",
"email": "",
"type": "IND"
}
],
"assetOwners": [
{
"address": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1996-06-10",
"mobile": "",
"email": "",
"type": "IND"
}
],
"siHolder": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110001,
"pincodeValue": "",
}
},
"transaction": {
"processId": 1,
},
}
},
+JVQkw=="
}
}
}
Response:
{
"header": {
"status": "success"
},
"body": {
"APIResponse": {
"matchingAssets": [
{
"uniqueId": "",
"createdBy": "A0016871XX",
"isDeleted": false,
"beaconFlag": true,
"assetTypeId": 1,
"beaconCount": 0,
"genericAsset": {
"area": 1200,
"plotId": "PID No 54-105-187",
"pincode": 560085,
"areaUnit": "6",
"isDeleted": false,
"stateCode": "17",
"floorNumber": "2",
"lcltySector": "Bangalore",
"strtNameNumber": "4th",
"assetDescription": "House",
"prjctSchmSociety": "NA",
"bldgTowerNameNumber": "No 187",
},
},
{
"isDeleted": false,
"beaconFlag": true,
"assetTypeId": 6,
"beaconCount": 0,
"genericAsset": {
"address": {
"country": "India",
"pincode": 560062,
"district": "Bengaluru",
"addressId": 111362697,
"isDeleted": false,
"stateCode": "17",
"stateName": "Karnataka",
"addressLine1": " Address Line One ",
"addressLine2": "",
"addressLine3": "",
"cityTownVillage": "Bangalore South",
},
"isDeleted": false,
"serialNum": "39XXXXXXX843",
"assetAddressId": 111362697,
"assetDescription": "Receivables",
},
"assetTypeOtherDesc": "Inventory (incl Receivables)"
}
],
"pgStatus": null,
"feeAmount": 1,
"processId": null,
"assetId": null,
}
}
}
• Sample request and response for Attachment Order
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
],
}
},
"body": {
"AdditionalInfo": {
},
"RequestPayload": {
"asset": {
"uniqueId": "",
"assetDesc": "Flat",
"assetTypeId": 1,
"genericAsset": {
"plotId": "",
"pocket": "",
"latlog1": "90 180",
"latlog2": "90 180",
"latlog3": "90 180",
"latlog4": "90 180",
"pincode": 400084,
"areaUnit": "",
"district": "Mumbai",
"stateCode": "21",
"floorNumber": "4",
"lcltySector": "GHATKOPAR WEST",
"ctyTwnVillage": "GHATKOPAR",
"strtNameNumber": "SAXXXXXXNE",
"srvyMncplNumber": "A Number",

"prjctSchmSociety": "SaiXXXXXan",
"bldgTowerNameNumber": "SaiXXXXXhan",
"houseFlatUnitNumber": "A 405"
},
},
"borrowers": [
{
"address": {
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1976-07-14",
"mobile": "",
"email": "",
"type": "IND"
}
],
"assetOwners": [
{
"address": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1996-06-10",
"mobile": "",
"email": "",
"type": "IND"
}
],
"siHolder": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110001,
"pincodeValue": "",
}
},
"transaction": {
"processId": 1,
},
"attachmentOrder": {
"caseYear": 2021,
"caseTitle": "CASE Title",
"caseNumber": "CAXXXXXXXXXX21",
"issuingAuthority": "Issuing Authority",
"attachmentOrderDate": "2021-06-11",
"totalRecoveryAmount": 17887899.99,
"userIdentificationNumber": "Dummy User Identification Number",
},
"typeOfCharge": "AO Type",
"totalSecuredAmount": 7887899.99,
"securityInterestSubType": "Attachment Order",
"userIdentificationNumber": "Dummy User Identification Number",
"securityInterestCreationDate": "2021-06-11"
}
},
+JVQkw=="
}
}
}
Response:
{
"header": {
"status": "success"
},
"body": {
"APIResponse": {
"matchingAssets": [
{
"createdBy": "MIG",
"isDeleted": false,
"beaconFlag": false,
"assetTypeId": 1,
"beaconCount": 0,
"genericAsset": {
"area": 500,
"plotId": "4 ",
"latlog1": "",
"pincode": 421207,
"areaUnit": "6",
"createdBy": "MIG",
"isDeleted": false,
"stateCode": "21",
"floorNumber": "4 ",
"lcltySector": "DOXXXXXXST ",
"strtNameNumber": "GUPTE ROAD ",
"srvyMncplNumber": "405 ",
"assetDescription": "Immovable Asset ",
"bldgTowerNameNumber": "RUXXXXXXXTS ",
"houseFlatUnitNumber": "A/405 "
},
}
],
"pgStatus": null,
"feeAmount": 1,
"processId": null,
"assetId": null,
}
}
}
• Sample request and response for Consortium
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
],
}
},
"body": {
"AdditionalInfo": {
},
"RequestPayload": {
"asset": {
"uniqueId": "",
"assetTypeId": 3,
"genericAsset": {
"area": 657,
"plotId": "876",
"pocket": "",
"latlog1": "90 180",
"latlog2": "90 180",
"latlog3": "90 180",
"latlog4": "90 180",
"pincode": 784510,
"areaUnit": "3",
"stateCode": "4",
"floorNumber": "",
"districtCode": 37,
},
},
"borrowers": [
{
"address": {
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1976-07-14",
"mobile": "",
"email": "",
"isAssetOwner": true,
"type": "IND"
}
],
"isRegistrationDedupBypassed": false,
"lenders": [
{
"chargeType": "First",
"entityCode": "BXXX1",
"isActive": 0,
"share": 50
},
{
"chargeType": "Second",
"entityCode": "BXXX2",
"isActive": 0,
"share": 30
}
],
"share": 20,
"typeOfCharge": "First Charge"
},
"siHolder": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110001,
"pincodeValue": "",
}
},
"transaction": {
"processId": 1,
}
},
"RequestHash": "MIIGbwYJKoZIhvcNAQcCoIIGYDCCBlwCAQExCzAJBg /…/ Ql
mUoW9+f/+JVQkw=="
}
}
}
Response:
{
"header": {
"status": "success"
},
"body": {
"APIResponse": {
"feeAmount": 4,
"matchingAssets": [
{
"beaconFlag": true,
"assetTypeId": 1,
"genericAsset": {
"area": 100,
"areaUnit": "6",
"pincode": 110032,
"prjctSchmSociety": "Pro",
"isDeleted": false,
"createdBy": "B006700001",
"assetId": 200050101969,
"plotId": "1",
"floorNumber": "1",
"stateCode": "10",
"lcltySector": "77",
"isDisabled": false
},
"isDeleted": false,
"createdBy": "B006700001",
"uniqueId": "",
"beaconCount": 0
}
],
"transactionId": 20XXXXXXXX12
}
}
}
• Sample request and response for Multiple
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
],
}
},
"body": {
"AdditionalInfo": {
},
"RequestPayload": {
"asset": {
"uniqueId": "",
"assetTypeId": 3,
"genericAsset": {
"area": 657,
"plotId": "876",
"pocket": "",
"latlog1": "90 180",
"latlog2": "90 180",
"latlog3": "90 180",
"latlog4": "90 180",
"pincode": 784510,
"areaUnit": "3",
"stateCode": "4",
"floorNumber": "",
"districtCode": 37,
},
},
"assetOwners": [
{
"address": {
"cityTownVillage": "Civil Lines",
"country": "India",
"district": "Delhi",
"pincode": 110054,
"stateCode": "10",
"stateName": "Delhi"
},
"dob": "1981-05-19",
"email": "",
"gender": "M",
"mobile": "",
"type": "IND"
}
],
"borrowers": [
{
"address": {
"district": "",
"stateCode": 10,
"pincode": 110054,
"pincodeValue": "",
},
"gender": "M",
"dob": "1976-07-14",
"mobile": "",
"email": "",
"type": "IND"
}
],
"isRegistrationDedupBypassed": true,
"securityInterestSubType": "Equitable Mortgage",
"totalSecuredAmount": 1000,
"typeOfCharge": "First Charges",
"userIdentificationNumber": "IDEXXXXXX14"
},
"siHolder": {
"addressLine2": "",
"addressLine3": "",
"district": "",
"stateCode": 10,
"pincode": 110001,
"pincodeValue": "",
}
},
"transaction": {
"processId": 1,
}
},
mUoW9+f/+JVQkw=="
}
}
}
Response:
{
"header": {
"transactionid": "f3rjiXXXXXXXXXXXXXXX33",
"status": "success"
},
"body": {
"APIResponse": {
"dedupStatus": "DBP",
"pgStatus": "NA",
"feeAmount": 2,
"assetId": 2XXXXXXXXXX9,
"securityInterestId": 4XXXXXXXXXX6
}
}
}
• Sample request and response for Borrower – Non Individual

Association of Persons (AOP)
Body of Individuals (BOI)
Indian Company (COM)
Foreign Company (FRC)
Government Body (GOV)
Hindu Undivided Family (HUF)
Limited Liability Partnership (LLP)
Not Categorised (NTC)
Partnership Firm (PRF)
Society (SOC)
Sole Proprietorship (SPR)
Trust(TRS)
• Sample request and response in case of Borrore is: SPR || PRF || HUF || SOC || AOP || BOI || TRS || GOV
|| NTC
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
],
}
},
"body": {
"AdditionalInfo": {
"IV": "<<Create 16-
byte IV parameter, Convert to String, encrypt using pre-
shared RSA public key, base-64 encoded>>"
},
"SessionKey": "<<Unique AES256 key, encrypt using pre-
shared RSA public key, base-64 encoded >>",
"RequestPayload": {
"asset": {
"assetDesc": "abc",
"assetTypeId": 5,
"genericAsset": {
"make": "abc",
"model": "abc",
"serialNum": "abc"
},
},
"siHolder": {
"officeName": "HEAD OFFICE",
"country": "India",
"pincode": 400018,
"stateCode": "21",
"addressLine1": "abc",
"addressLine2": "",
"addressLine3": "",
"cityTownVillage": "WORLI MUMBAI",
}
},
"borrowers": [
{
"pan": "",
"ckyc": "99999XXXXXXXX9",
"name": "abc",
"type": "SPR",
"address": {
"country": "India",
"pincode": 416122,
"district": "Kolhapur",
"stateCode": "21",
"addressLine2": "",
"addressLine3": "",
"cityTownVillage": "kolhapur",
},
"regNumber": "9XX9",
"incorporationDate": "2001-09-19"
}
],
"transaction": {
"processId": 1,
"transactionMode": "A",
"omissionReasonCategory": ""
},

"financingType": "Sole",
"totalSecuredAmount": 710XXXX0,
"securityInterestSubType": "Hypothecation",
"userIdentificationNumber": "000XXXXXX9",
"securityInterestFilingTimestamp": "2023-08-
07 17:34:32.311"
}
},
mUoW9+f/+JVQkw=="
}
}
}
Response:
{
"header": {
"transactionid": "40y870169268XXXXXXXXXXX3",
"status": "success"
},
"body": {
"APIResponse": {
"pgStatus": "NA",
"feeAmount": 3,
"securityInterestId": 400XXXXXXXX2
}
}
}
• Sample request and response in case of Borrore is: Indian Company (COM)
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",
pre- shared RSA public key, base-64 encoded>>"
],
}
},
"body": {
"AdditionalInfo": {
"IV": "<<Create 16-
},
"RequestPayload": {
"asset": {
"assetDesc": "abc",
"assetTypeId": 5,
"genericAsset": {
"make": "abcd",
"model": "abc",
"serialNum": "abc"
},
},
"siHolder": {
"country": "India",
"pincode": 400018,
"stateCode": "21",
"addressLine1": "570 P B MARG",

"addressLine2": "",
"addressLine3": "",
}
},
"borrowers": [
{
"pan": "",
"name": "abc",
"type": "COM",
"address": {
"country": "India",
"pincode": 416122,
"stateCode": "21",
"addressLine2": "",
"addressLine3": "",
},
"regNumber": "A00XX0AA0XX0AAA0XXXX0",
}
],
"transaction": {
"processId": 1,
},
"userIdentificationNumber": "asdXXXXXdjf",
07 16:52:02.148"
}
},
mUoW9+f/+JVQkw=="
}
}
}
Response:
{
"header": {
"status": "success"
},
"body": {
"APIResponse": {
"pgStatus": "NA",
"feeAmount": 3,
}
}
}
• Sample request and response in case of Borrore is: Foreign Company (FRC)
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",

],
}
},
"body": {
"AdditionalInfo": {
"IV": "<<Create 16-
},
"RequestPayload": {
"asset": {
"assetDesc": "abc",
"assetTypeId": 5,
"genericAsset": {
"make": "abc",
"model": "abcd",
"serialNum": "abc"
},
},
"siHolder": {
"country": "India",
"pincode": 400018,
"stateCode": "21",
"addressLine2": "",
"addressLine3": "",
}
},
"borrowers": [
{
"pan": "",
"name": "abc",
"type": "PRF",
"address": {
"country": "India",
"pincode": 416122,
"stateCode": "21",
"addressLine1": "Plot No G13 MIDC Shiroli",
"addressLine2": "",
"addressLine3": "",
},
"regNumber": "123",
}
],
"transaction": {
"processId": 1,
},
"totalSecuredAmount": 71XXXXX0,
"userIdentificationNumber": "00XXXXXXX9",
07 16:33:10.198"
}
},
mUoW9+f/+JVQkw=="
}
}
}
Response:
{
"header": {
"status": "success"
},
"body": {
"APIResponse": {
"pgStatus": "NA",
"feeAmount": 3,
}
}
}
• Sample request and response in case of Borrore is: Limited Liability Partnership (LLP)
Request:
{
"header": {
"authinfo": {
"LoginParams": [
"APILOGIN",
"<<API User Id>>",

],
}
},
"body": {
"AdditionalInfo": {
"IV": "<<Create 16-
},
"RequestPayload": {
"asset": {
"assetDesc": "abc",
"assetTypeId": 5,
"genericAsset": {
"make": "abc",
"model": "abc",
"serialNum": "abc"
},
},
"siHolder": {
"country": "India",
"pincode": 400018,
"stateCode": "21",
"addressLine2": "",
"addressLine3": "",
}
},
"borrowers": [
{
"pan": "",
"ckyc": "",
"name": "abc",
"type": "LLP",
"address": {
"country": "India",
"pincode": 416122,
"stateCode": "21",
"addressLine1": "Plot No G13 MIDC Shiroli",
"addressLine2": "",
"addressLine3": "",
},
"regNumber": "9XXXXX9",
}
],
"transaction": {
"processId": 1,
},
"userIdentificationNumber": "98XXXXXX9",
07 16:59:36.639"
}
},
mUoW9+f/+JVQkw=="
}
}
}
Response:
{
"header": {
"status": "success"
},
"body": {
"APIResponse": {
"pgStatus": "NA",
"feeAmount": 3,
}
}
}
Annexure II: Server-Side Validations – Security Interest Registration

For Security Interest –
Table 5: Field Validation for Security Interest
MANDATORY /
SR NO FIELD NAME DATA TYPE FIELD DESCRIPTION FIELD VALIDATION
OPTIONAL?
The type of security interest

such as equitable mortgage,
registered mortgage, agreement
Only fixed set of values
securityInter to create mortgage, etc. Please
1 Number Yes allowed (as per master
estSubTypeId refer corresponding master
table / data set)
available in the "Downloads"
section on the CERSAI portal for
allowed values.
Alphanumeric
Characters; Special
The description of the type of Character(s) Allowed:
security interest in case Hyphen / Underscore /
securityInter securityInterestSubTypeIdis Dot / Comma / Forward
2 estSubTypeO String Conditional "Others". It becomes mandatory Slash / Whitespace;
thers when Consecutive special

securityInterestSubTypeId is characters not allowed;
"Others". Must not begin or end

with a special character;
Max Length:100;
The type of financing in this

security interest. Please refer to
financingTypeI the corresponding master
d available in the "Downloads"
table / data set)
allowed values.
This is the date on which Date Format: YYYY-MM-

4 securityInteres Date Yes
security interest was created in DD; Future date not
tCreationDate favour of the creditor / date of allowed; Minimum Date

attachment order. is 1900;
Numbers only; No Space

Allowed; Special
Character(s) Allowed:
Dot (Only One); Must be
greater than zero; Other
Field Specific Validations
This is the total secured amount
may apply (Example:
of the security interest. This
totalSecuredA Credit Upload Amount
5 Decimal Yes must be greater than zero.
mount must not exceed 1
Values up to two decimal places
Crore; Credit Upload
are allowed.
Amount must be in
multiples of 100 / 1000 /
etc.);
Maximum Amount: -
9999999999999; Max
length:13;
This will be a generic field for

Alphanumeric
Entities’ internal MIS /
Characters; No Space
userIdentificat reconciliation purpose. Entities
6 String Yes Allowed; Special
ionNumber may use this field to provide BSR
code, Loan Account Number,
None: Max Length:20;
Transaction Id, etc.
Alphanumeric
Characters; Special
Hyphen / Underscore /
This is a free text field to capture
Dot / Comma / Forward
7 miscNarration String No information relevant to security
Slash / Whitespace;
interest.
Consecutive special
characters not allowed;
Must not begin or end
Max Length:100;
This is the type of charge of the Alphabets only; Special

creditor such as first charge, Character(s) Allowed:
second charge, pari passu, etc. Whitespace;
This should be the type of Consecutive special
8 typeOfCharge String Yes
charge of the creditor or the characters not allowed;
type of charge of the consortium Must not begin or end
leader in case of consortium with a special character;
security interest(s). Max Length:20;
For Attachment Order –

Table 6: Field Validation for Attachment Order
DATA MANDATORY /
SR NO FIELD NAME FIELD DESCRIPTION FIELD VALIDATION
TYPE OPTIONAL?
Alphanumeric Characters;
Special Character(s)
Allowed: Hyphen /
The field for name of the issuing
Underscore / Dot /
issuingAutho Authority / Court / Tribunal who
1 String Yes Whitespace; Consecutive
rity has issued the Attachment
special characters not
Order.
allowed; Must not begin
or end with a special
character;Max Length:50;
The year in which the Minimum year:1900 ;No

2 caseYear Number Yes
Attatchment Order was filed. Future Year Allowed
The case number of the Fixed Length: 7; Special
3 caseNumber Number Yes
Attatchment Order. Character(s) Allowed:
None;
The case title of the Attatchment Fixed Length: 6; Special
4 caseTitle String Yes
Order. Character(s) Allowed:
None;
Numbers only; No Space

Allowed; Special
This is the total secured amount Character(s) Allowed: Dot
of the security interest. This (Only One); Must be
totalRecover
5 Decimal Yes must be greater than zero. greater than zero; Other
yAmount
Values up to two decimal places Field Specific Validations
are allowed. may apply (Example:
Credit Upload Amount
must not exceed 1 Crore;
Credit Upload Amount

must be in multiples of
100 / 1000 / etc.);
Maximum Amount: -
9999999999999; Max
length:13;
This will be a generic field for

Entities’ internal MIS / Alphanumeric Characters;
userIdentific
reconciliation purpose. Entities No Space Allowed; Special
6 ationNumbe String Yes
may use this field to provide BSR Character(s) Allowed:
r
code, Loan Account Number, None: Max Length:20;
Transaction Id, etc.
Allowed: Hyphen /
Underscore / Dot /
This is a free text field to capture Comma / Forward Slash /
miscNarratio
7 String No information relevant to security Whitespace; Consecutive
n
interest. special characters not
character; Max
Length:100;
For Immovable Assets –

Table 7: Field Validation for Immovable Assets
DATA MANDATORY /
TYPE OPTIONAL?
The type of asset category that is Only fixed set of values

immovable. Please refer to the allowed (as per master
assetCategor
1 Number Yes corresponding master available in table / data set)
yId
the "Downloads" section on the
CERSAI portal for allowed values.
The type of asset such as

residential, commercial or others.
Please refer to the corresponding
2 assetTypeId Number Yes allowed (as per master
master available in the
table / data set)
"Downloads" section on the
Alphanumeric
Characters; Special
The description of the type of
assetTypeOt asset in case ASSET_TYPE_ID is
3 String Conditional Slash / Whitespace;
herDesc "Others". It becomes mandatory
Consecutive special
when ASSET_TYPE_ID is "Others".
Maximum Length:50
The asset sub types such as

Structure with Land, Structure
assetSubTyp without Land, Land without
eId Structure etc. Please refer
table / data set)
corresponding master available in
Alphanumeric
Characters; Special
This is a mandatory text field to
Slash / Whitespace;
5 assetDesc String Yes capture information relevant to
Consecutive special
the asset.
with a special
character;Maximum
Length:100;
This field is to capture survey

numbers of immovable asset.
Multiple survey numbers can be
Generic with Separator
srvyMncplNu entered with comma as a
6 String Conditional (^); Maximum
mber seperator. Either
Length:1000
SURVEY_NUMBER or
PLOT_NUMBER one must be
entered.
Alphanumeric
Characters; Special
The field to enter plot number of Hyphen / Underscore /
immovable asset. Either Dot / Forward Slash /
7 plotId String Conditional SURVEY_NUMBER or Whitespace; Consecutive
PLOT_NUMBER one must be special characters not
entered. allowed; Must not begin
character;Maximum
Length:20;
The optional field to enter the Decimal(7,2);Max

8 area Decimal No
area of immovable asset. Length:9;
The field to enter the unit of area Only fixed set of values
of asset entered in ASSET_AREA. It allowed (as per master
9 areaUnit String Conditional
is mandatory when ASSET_AREA table / data set)
field is entered.
Alphanumeric
Characters; Special
The field for house number or flat Character(s) Allowed:
number or unit number of the Hyphen / ForwardSlash /
houseFlatUni immovable asset. It is mandatory Whitespace; Consecutive
10 String Conditional
tNumber when ASSET_SUB_TYPE is special characters not
''Structure with Land'' or allowed; Must not begin
''Structure without Land''. or end with a special
character;Max
Length:20;
This field is for floor number of the Only fixed set of values
11 floorNumber String No asset and values can be from -3 to allowed (as per master
100. table / data set)
Alphanumeric
Characters; Special
This field is for Building name/
Dot / Whitespace;
bldgTowerN Building number/ Tower name/
12 String No Consecutive special
ameNumber Tower number of the immovable
asset.
with a special
character;Max
Length:50;
Alphanumeric
Characters; Special
This field is for the name of the Dot / Whitespace;
prjctSchmSo
13 String Yes Project/ Scheme/ Society of the Consecutive special
ciety
immovable asset. characters not allowed;
with a special
character;Max
Length:50;
Alphanumeric
Characters; Special
Hyphen / ForwardSlash /
The field to enter the Street name
strtNameNu Whitespace; Consecutive
14 String No or Street number of the
mber special characters not
immovable asset.
character;Max
Length:50;
Alphanumeric
Characters; Special
Dot / Forward Slash /
The field to enter the Pocket
15 pocket String No Whitespace; Consecutive
numberof the immvoable asset.
character;Max
Length:20;
Alphanumeric
Characters; Special
This field is for Locality/ Sector of
16 lcltySector String Yes Whitespace; Consecutive
the immovable asset.
character;Max
Length:50;
This field is for City/ Village/ Town Only fixed set of values
name of the immovable asset. allowed (as per master
cityTownVill Please refer to the corresponding table / data set)
17 String Yes
ageCode master available in the
The field for District of the Only fixed set of values

immovable asset. Please refer to allowed (as per master
the corresponding master table / data set)
18 districtCode String Yes
allowed values.
The field for the name of the State Only fixed set of values
of the immovable asset. Please allowed (as per master
refer to the corresponding master table / data set)
19 stateCode String Yes
allowed values.
The field for 6-digit Pin-Code / Only fixed set of values

Post-Code of the immvobale asset. allowed (as per master
20 pincode Number Yes
Please refer to the corresponding table / data set)

The field for the name of the Only fixed set of values
Country of the immovable asset. allowed (as per master
21 countryCode String Yes
Longitude-Numbers
only; Special Character(s)
Allowed: Dot (Only One);
The field LATITUDE_LONGITUDE_1 Must be in range -180 to
is for the 1st location co-ordinates 180;
22 latlog1 String No
(latitude and longitude) of the Latitude- Numbers only;
immovable asset. Special Character(s)
Must be in range -90 to
90;
Longitude-Numbers
is for the 2nd location co- 180;
23 Latlog2 String No
ordinates (latitude and longitude) Latitude- Numbers only;
of the immovable asset. Special Character(s)
90;
Longitude-Numbers
The field LATITUDE_LONGITUDE_3
is for the 3rd location co-ordinates
24 Latlog3 String No Allowed: Dot (Only One);
(latitude and longitude) of the
immovable asset.
180;
Latitude- Numbers only;

90;
Longitude-Numbers only;
is for the 4th location co-ordinates 180;
25 Latlog4 String No
(latitude and longitude) of the Latitude- Numbers only;
immovable asset. Special Character(s)
90;
For Movable Assets –

Table 8: Field Validation for Movable Assets
MANDATORY /
OPTIONAL?

movables. Please refer to the allowed (as per master
assetCategory
Id
The type of asset such as Only fixed set of values

equipment and machinery, allowed (as per master
inventory(incl receivables) or table / data set)
2 assetTypeId Number Yes others. Please refer to the
Alphanumeric
Characters; Special
The description of the type of Dot / Comma / Forward
assetTypeOth asset in case ASSET_TYPE_ID is Slash / Whitespace;
erDesc "Others". It becomes mandatory Consecutive special
when ASSET_TYPE_ID is "Others". characters not allowed;
with a special
character;Maximum
Length:100;
The asset sub types such as Ship, Only fixed set of values
assetSubTypeI
4 Number No Yatch, Aircraft etc. Please refer allowed (as per master
d
corresponding master available table / data set)
inthe "Downloads" section on the

Alphanumeric
Characters; Special
The field is for Serial number Character(s) Allowed:
when ASSET_TYPE_ID is Hyphen / ForwardSlash
"Equipment and Machinery" and / Whitespace;
5 serialNum String Yes for Asset Distinct/ Identification Consecutive special
Number when ASSET_TYPE_ID is characters not allowed;
"Inventory (incl. Receivables)" or Must not begin or end
"Others". with a special
character;Maximum
Length:50;
Alphanumeric
Characters; Special
Slash / Whitespace;
6 assetDesc String Yes description of asset for all types
Consecutive special
of movbale asset.
with a special
character;Maximum
Length:100;
Alphanumeric
Characters; Special
This is a text field for the Make of Hyphen / Underscore /
7 make String Conditional the Asset when ASSET_TYPE_ID is Dot / Whitespace;
"Equipment and Machinery". Consecutive special
with a special
character;Maximum
Length:100;
Alphanumeric
Characters; Special
This is a text field for the Model Dot / Comma / Forward
of the Asset when Slash / Whitespace;
8 model String Conditional
ASSET_TYPE_ID is "Equipment Consecutive special
and Machinery". characters not allowed;
with a special
character;Maximum
Length:100;
Alphanumeric
Characters; Special
The 1st line of the address details Dot / Forward Slash /
of the movable asset. It may Whitespace;
9 addressLine1 String Conditional
include Flat number, Building Consecutive special
number, Building name etc. characters not allowed;
with a special
character;Maximum
Length:100;
Alphanumeric
The 2nd line of the address
Characters; Special
details of the movable asset. It
10 addressLine2 String No Character(s) Allowed:
may include Plot number, Street
name etc.
Whitespace;
Consecutive special
with a special
character;Maximum
Length:100;
Alphanumeric
Characters; Special
The 3rd line of the address details Dot / Forward Slash /
of the movable asset. It may Whitespace;
11 addressLine3 String No
include Locality, Village, Taluka Consecutive special
etc. characters not allowed;
with a special
character;Maximum
Length:100;
This field is for City/ Village/ Only fixed set of values

Town name of the movable asset. allowed (as per master
cityTownVilla Please refer to the corresponding table / data set)
geCode master available in the
The field for District of the Only fixed set of values

movable asset. Please refer to allowed (as per master
the corresponding master table / data set)
13 districtCode String Conditional
allowed values.
14 stateCode String Conditional
State of the movable asset. allowed (as per master

The field for 6-digit Pin-Code / Only fixed set of values

Post-Code of the mvobale asset. allowed (as per master
Please refer corresponding table / data set)
15 pincode Number Conditional
16 countryCode Constant Conditional "IND" **
For Intangible Assets –

Table 9: Field Validation for Intangible Assets
DATA MANDATORY /
TYPE OPTIONAL?

intangibles. Please refer allowed (as per master
assetCategoryI
d
The type of asset such as patents,

license, design etc. Please refer Only fixed set of values
2 assetTypeId Number Yes corresponding master available in allowed (as per master
the "Downloads" section on the table / data set)
Alphanumeric
Characters; Special
The description of the type of Dot / Comma / Forward
assetTypeOth asset in case ASSET_TYPE_ID is Slash / Whitespace;
erDesc "Others". It becomes mandatory Consecutive special
when ASSET_TYPE_ID is "Others". characters not allowed;
with a special
character;Maximum
Length:100;

assetSubTypeI
4 Number No NULL allowed (as per master
d
table / data set)
Alphanumeric
Characters; Special
The field is for Asset Distinct/
Slash / Whitespace;
5 serialNum String No Identification Number when
Consecutive special
ASSET_TYPE_ID is "Others".
with a special
character;Maximum
Length:50;
Alphanumeric
Characters; Special
Slash / Whitespace;
6 assetDesc String Yes description of asset for all types
Consecutive special
of intangible asset.
with a special
character;Maximum
Length:100;
Alphanumeric
Characters; Special
This field is for the Diary number
7 diaryNumber String Conditional when ASSET_TYPE_ID is
Slash / Whitespace;
"Copyright".
Consecutive special
with a special
character;Maximum
Length:20;
Alphanumeric
Characters; Special
This field is for the Class of Work
Slash / Whitespace;
8 copyrightClass String Conditional when ASSET_TYPE_ID is
Consecutive special
"Copyright".
with a special
character;Maximum
Length:50;
Alphanumeric
Characters; Special
This field is for the Title of Work
Slash / Whitespace;
9 copyrightTitle String Conditional when ASSET_TYPE_ID is
Consecutive special
"Copyright".
with a special
character;Maximum
Length:100;
Alphanumeric
Characters; Special
This field is for the Patent
patentNumbe Slash / Whitespace;
10 String Conditional number when ASSET_TYPE_ID is
r Consecutive special
"Patent".
with a special
character;Maximum
Length:20;
Date Format: YYYY-MM-

This field is for the Date of Patent
DD;Future date not
11 patentDate Date Conditional registration when ASSET_TYPE_ID
allowed;Minimum Date
is "Patent".
is 1900;
Alphanumeric
Characters; Special
This field is for the License
licenseNumbe Slash / Whitespace;
r Consecutive special
"License".
with a special
character;Maximum
Length:20;
Alphanumeric
This field is for the name of Characters; Special
licenseIssuing
13 String Conditional Issuing Authority of License when Character(s) Allowed:
Authority
ASSET_TYPE_ID is "License". Hyphen / Underscore /
Dot / Whitespace;
Consecutive special
with a special
character;Maximum
Length:100;
Alphanumeric
Characters; Special
This field is for the Category of
licenseCategor Slash / Whitespace;
14 String Conditional License when ASSET_TYPE_ID is
y Consecutive special
"License".
with a special
character;Maximum
Length:50;
Alphanumeric
Characters; Special
This field is for the Design
iprDesignNum Slash / Whitespace;
ber Consecutive special
"IPR" or "Design".
with a special
character;Maximum
Length:20;
Alphanumeric
Characters; Special
This field is for the Design Class
Slash / Whitespace;
16 iprDesignClass String Conditional when ASSET_TYPE_ID is "IPR" or
Consecutive special
"Design".
with a special
character;Maximum
Length:20;
Alphanumeric
Characters; Special
This field is for the Trademark
trmkApplNum Slash / Whitespace;
17 String Conditional application number when
ber Consecutive special
ASSET_TYPE_ID is "Trademark".
with a special
character;Maximum
Length:20;
This field is for the registration Date Format: YYYY-MM-

date of Trademark application DD;Future date not
18 trmkApplDate Date Conditional
when ASSET_TYPE_ID is allowed;Minimum Date
"Trademark". is 1900;
For Borrowers -
Table 10: Field Validation for Borrowers
DATA MANDATORY /
TYPE OPTIONAL?
The type of Borrower such as

Company, Individual, Society,
Trust etc. Please refer
1 type String Yes allowed (as per master
table / data set)
This is a boolean value indicating

whether the borrower is a asset
2 isAssetOwner Boolean Yes owner or not. Valid values and 0 True / False
and 1 for false and true
respectively.
Alphanumeric
Characters; Fixed
Length: 10 characters;
Allowed: None; First five
characters must be
The field for Borrower PAN
alphabets, next 4
number when BORROWER_TYPE
characters must be
is Sole Proprietorship /
numbers and last
3 pan String No Partnership Firm / HUF / Indian
character must be
Company etc. that is
alphabet; Fourth
BORROWER_TYPE is "Other than
character is according to
Individual".
status of PAN holder: "P
(Individual)" / "C
(Company)" / "H (Hindu
Undivided Family)" / "A
(Association of
Persons)" / "B (Body of
Individuals)" / "G
(Government Agency)" /
"J (Artificial Juridicial
Person)" / "L (Local
Authority)" / "F (Firm /
Limited Liability
Partnership)" / "T
(Trust)"; Fifth character
is the first character of
PAN holder's last name
/ surname (In case of
Individuals) or the first
character of PAN
holder's name (In case
of other than
Individuals); Last
character is alphabetic
check digit; Must match
accordingly with GSTIN;
(Note: Dummy PAN -
AAAAA9999B).
PAN of the Borrower is
non mandatory
The field for Borrower CKYC

number when BORROWER_TYPE Numbers only; Fixed
is Sole Proprietorship / Length: 14; Special
4 ckyc Number No Partnership Firm / HUF / Indian Character(s) Allowed:
Company etc. that is None; (KYC Identification
BORROWER_TYPE is "Other than Number (KIN));
Individual".
Alphanumeric
Characters; Special
The field for Borrower Name Hyphen / Underscore /
when BORROWER_TYPE is Sole Dot / Whitespace;
Proprietorship / Partnership Firm Consecutive special
5 name String Conditional
/ HUF / Indian Company etc. that characters not allowed;
is BORROWER_TYPE is "Other Must not begin or end
than Individual". with a special character
Maximum Length: 100
For Borrower type Other
Than Individual
The field for Date of

Incorporation/ Formation when
BORROWER_TYPE is Sole
incorporation DD;Future date not
6 Date Conditional Proprietorship / Partnership Firm
Date allowed;Minimum Date
/ HUF / Indian Company etc. that
is 1900;
is BORROWER_TYPE is "Other
than Individual".
CIN: Alphanumeric
Characters; Fixed
Length: 21; Special
None; First character
must be an alphabet;
This field is mandatory when Next five characters
7 regNumber String Conditional BORROWER_TYPE is Indian must be numbers; Next
Company/LLP's. two characters must be
alphabets; Next four
characters must be
numbers; Next three
characters must be
alphabets; Next six
characters must be
numbers;
LLPIN :Alphanumeric
Characters; Fixed
Length: 7; Special
None;
Only alpha numeric with

Hyphen / Forward Slash
is allowed in Registration
No.
Registration no should
be mandatory in case
Type of Borrower is
Indian Company &LLPin.
Alphanumeric
Characters; Fixed
Length: 10 characters;
Allowed: None; First five
characters must be
alphabets, next 4
The field for Borrower PAN characters must be
8 individualPan String No number when BORROWER_TYPE numbers and last
is "Individual". character must be
alphabet; Fourth
(Individual)" / "C
(Association of
Persons)" / "B (Body of

Individuals)" / "G
Limited Liability
Partnership)" / "T
(Trust)"; Fifth character
is the first character of
PAN holder's last name
/ surname (In case of
character of PAN
holder's name (In case
of other than
Individuals); Last
(Note: Dummy PAN -
AAAAA9999B)
PAN of the Borrower is
non mandatory
Numbers only; Special

The field for Borrower CKYC Character(s) Allowed:
9 individualCkyc Number No number when BORROWER_TYPE None; (KYC Identification
is "Individual". Number
(KIN));FixedLength:14;
The field for Gender of the Only fixed set of values

10 gender String Conditional Borrower when allowed (as per master
BORROWER_TYPE is "Individual". table / data set)
Alphabets only; Special

Whitespace;
The field for Name of the Consecutive special
individualNam
11 String Conditional Borrower when characters not allowed;
e
BORROWER_TYPE is "Individual". Must not begin or end
with a special
character;Maximum
Length:50;

Whitespace;
The field for Father/ Mother's Consecutive special
fatherMother
12 String Conditional name of the Borrower when characters not allowed;
Name
BORROWER_TYPE is "Individual". Must not begin or end
with a special
character;Maximum
Length:50;

DD;Future date not
allowed;Minimum Date
The field for Date of Birth of the is 1900;
13 dob Date Conditional Borrower when Date of Birth of the
BORROWER_TYPE is "Individual". Borrower is non
mandatory if Type of
Transaction is
Attachment Order

The field for Borrower's mobile
14 mobile Number No number when BORROWER_TYPE
None; Fixed Length: 10
is "Individual".
digits;
Alphanumeric
Characters; Special
Character(s) Allowed: At
The field for Borrower's email id Sign (Only One) /
15 email String No when BORROWER_TYPE is Underscore / Dot;
"Individual". Atleast one Dot after At
Sign; Underscore
Allowed Before At Sign;
Maximum Length:50;
Alphanumeric
Characters; Special
The 1st line of the address details Dot / Forward Slash /
of the borrower. It may include Whitespace;
16 addressLine1 String Yes
Flat number, Building number, Consecutive special
Building name etc. characters not allowed;
with a special
character;Maximum
Length:100;
Alphanumeric
Characters; Special
The 2nd line of the address Dot / Forward Slash /
details of the borrower. It may Whitespace;
include Plot number, Street Consecutive special
name etc. characters not allowed;
with a special
character;Maximum
Length:100;
Alphanumeric
Characters; Special
The 3rd line of the address details
Whitespace;
18 addressLine3 String No of the borrower. It may include
Consecutive special
Locality, Village, Taluka etc.
with a special
character;Maximum
Length:100;
This field is for City/ Village/

Town name of the borrower.
cityTownVillag Please refer corresponding
19 String Yes allowed (as per master
eCode master available in the
table / data set)
The field for District of the

borrower. Please refer Only fixed set of values
20 districtCode String Yes corresponding master available in allowed (as per master
The field for the name of the

State of the borrower. Please
refer corresponding master
21 stateCode String Yes allowed (as per master
table / data set)
allowed values.
The field for 6-digit Pin-Code /

Post-Code of the borrower.
22 pincode Number Yes allowed (as per master
Please refer corresponding
table / data set)

23 countryCode String Yes "IN" **
For Asset Owner –

Table 11: Field Validation for Asset Owner
MANDATORY /
OPTIONAL?
The type of Asset Owner such as

Company, Individual, Society,
Trust etc. Please refer
1 type String Yes allowed (as per master
table / data set)
Fixed Length: 10
characters; Special
None; First five characters
must be alphabets, next 4
characters must be
numbers and last
The field for Asset Owner PAN character must be
number when alphabet; Fourth
Asset_Owner_TYPE is Sole character is according to
2 pan String No Proprietorship / Partnership Firm status of PAN holder: "P
/ HUF / Indian Company etc. that (Individual)" / "C
is Asset_Owner_Type is "Other (Company)" / "H (Hindu
than Individual". Undivided Family)" / "A
(Association of Persons)"
/ "B (Body of
Individuals)" / "G
Limited Liability
Partnership)" / "T
(Trust)"; Fifth character is
the first character of PAN
holder's last name /
surname (In case of
character of PAN holder's
name (In case of other
than Individuals); Last
(Note: Dummy PAN -
AAAAA9999B).
PAN of the Asset Owner is

non mandatory
The field for Asset Owner CKYC

number when Numbers only; Fixed
Asset_Owner_TYPE is Sole Length: 14; Special
3 ckyc Number Conditional Proprietorship / Partnership Firm Character(s) Allowed:
/ HUF / Indian Company etc. that None; (KYC Identification
is Asset_Owner_Type is "Other Number (KIN));
than Individual".
The field for Asset Owner Name
Allowed: Hyphen /
when Asset_Owner_TYPE is Sole
Underscore / Dot /
Proprietorship / Partnership Firm
4 name String Conditional Whitespace; Consecutive
is Asset_Owner_Type is "Other
than Individual".
character;MaximumLengt
h: 100 For Asset Owner

type Other Than
Individual
The field for Date of

Incorporation/ Formation when
Asset_Owner_Type is Sole
incorporation DD;Future date not
5 Date Conditional Proprietorship / Partnership Firm
Date allowed;Minimum Date is
1900;
is Asset_Owner_Type is "Other
than Individual".
CIN: Alphanumeric
Characters; Fixed Length:
21; Special Character(s)
Allowed: None; First
character must be an
alphabet; Next five
characters must be
The field for Registration number numbers; Next two
like CIN, LLPinetc when characters must be
Asset_Owner_Type is Sole alphabets; Next four
6 regNumber String Conditional Proprietorship / Partnership Firm characters must be
/ HUF / Indian Company etc. that numbers; Next three
is Asset_Owner_Type is "Other characters must be
than Individual". alphabets; Next six
characters must be
numbers;
LLPIN :Alphanumeric
Characters; Fixed Length:
7; Special Character(s)
Allowed: None;
Only alpha numeric with

Hyphen / Forward Slash is
allowed in Registration
No.
Registration no should be
mandatory in case Type of
Asset Owner is Indian
Company &LLPin.
Fixed Length: 10
characters; Special
None; First five characters
must be alphabets, next 4
characters must be
numbers and last
The field for Asset Owner PAN
character must be
number when
7 individualPan String No alphabet; Fourth
Asset_Owner_Type is
"Individual".
(Individual)" / "C
(Association of Persons)"
/ "B (Body of
Individuals)" / "G

Limited Liability
Partnership)" / "T
(Trust)"; Fifth character is
the first character of PAN
holder's last name /
surname (In case of
character of PAN holder's
name (In case of other
than Individuals); Last
(Note: Dummy PAN -
AAAAA9999B).
PAN of the Asset Owner
is non mandatory
Numbers only; Fixed

The field for Asset Owner CKYC
Length: 14; Special
number when
8 individualCkyc Number No Character(s) Allowed:
Asset_Owner_Type is
None; (KYC Identification
"Individual".
Number (KIN));
The field for Gender of the Asset Only fixed set of values
9 gender String Conditional Owner when Asset_Owner_Type allowed (as per master
is "Individual". table / data set)

The field for Name of the Asset
individualNam Whitespace; Consecutive
10 String Conditional Owner when Asset_Owner_Type
e special characters not
is "Individual".
character;Maximum
Length:50 for Asset
Owner type Individual

The field for Father/ Mother's Whitespace; Consecutive
fatherMother name of the Asset Owner when special characters not
Name Asset_Owner_Type is allowed; Must not begin
"Individual". or end with a special
character;Maximum
Length:50;

DD;Future date not
The field for Date of Birth of the allowed;Minimum Date is
Asset Owner when 1900;
12 dob Date Conditional
Asset_Owner_Type is Date of Birth of the Asset
"Individual". Owner is non mandatory
if Type of Transaction is
Attachment Order
The field for Asset Owner's Numbers only; Special

mobile number when Character(s) Allowed:
13 mobile Number No
Asset_Owner_Type is None; Fixed Length: 10
"Individual". digits;
Allowed: At Sign (Only
The field for Asset Owner's email
One) / Underscore / Dot;
14 email String No id when Asset_Owner_Type is
Atleast one Dot after At
"Individual".
Sign; Underscore Allowed
Before At Sign; Maximum
Length:50;
Allowed: Hyphen /
Underscore / Dot /
The 1st line of the address details
Forward Slash /
of the Asset Owner. It may
15 addressLine1 String Yes Whitespace; Consecutive
include Flat number, Building
number, Building name etc.
character;Maximum
Length:100;
Allowed: Hyphen /
Underscore / Dot /
The 2nd line of the address
Forward Slash /
details of the Asset Owner. It may
16 addressLine2 String No Whitespace; Consecutive
include Plot number, Street
name etc.
character;Maximum
Length:100;
Allowed: Hyphen /
Underscore / Dot /
The 3rd line of the address details
Forward Slash /
of the Asset Owner. It may
17 addressLine3 String No Whitespace; Consecutive
include Locality, Village, Taluka
etc.
character;Maximum
Length:100;

Town name of the Asset Owner.
cityTownVilla Please refer corresponding
geCode master available in the
table / data set)
The field for District of the Asset

Owner. Please refer Only fixed set of values
The field for the name of the

State of the Asset Owner. Please
refer corresponding master
20 stateCode String Yes allowed (as per master
table / data set)
allowed values.

Post-Code of the Asset Owner.
table / data set)
22 countryCode String Yes "IN" **
For Charge Holder –

Table 12: Field Validation for Charge Holder
DATA MANDATORY /
TYPE OPTIONAL?

Whitespace;
This field is for the Office/ Ward/ Consecutive special
1 officeName String Yes Branch name of the Charge characters not allowed;
Holder. Must not begin or end
with a special
character;Maximum
Length:100;
Alphanumeric
Characters; Special
The 1st line of the office address
details of the Charge Holder. It
Whitespace;
2 addressLine1 String Yes may include Flat number,
Consecutive special
Building number, Building name
etc.
with a special
character;Maximum
Length:100;
Alphanumeric
Characters; Special
The 2nd line of the office address Character(s) Allowed:
details of the Charge Holder. It Hyphen / Underscore /
may include Plot number, Street Dot / Forward Slash /
name etc. Whitespace;
Consecutive special

with a special
character;Maximum
Length:100;
Alphanumeric
Characters; Special
The 3rd line of the office address Dot / Forward Slash /
details of the Charge Holder. It Whitespace;
may include Locality, Village, Consecutive special
Taluka etc. characters not allowed;
with a special
character;Maximum
Length:100;

Town name of the Charge Holder.
cityTownVillag Please refer corresponding
eCode master available in the
table / data set)
The field for District of the Charge

Holder. Please refer Only fixed set of values
7 stateCode String Yes State of the Charge Holder. allowed (as per master
Please refer corresponding table / data set)


Post-Code of the Charge Holder.
table / data set)
9 countryCode Constant Yes "IN" **
For Consortium –
Table 13: Field Validation for Consortium
DATA MANDATORY /
TYPE OPTIONAL?
The 5-character alphanumeric Only fixed set of values

1 entityCode String Yes code of the entity corresponding allowed (as per Entity
to its name. master table / data set)

Whitespace;
This is the type of charge of the Consecutive special
2 chargeType String Yes creditor such as first charge, characters not allowed;
second charge, pari passu, etc. Must not begin or end
with a special
character;Maximum
Length:20;

The numeric value of the share of Dot (Only One); Must be
3 share Decimal Yes
entity. in range 0-100;
Overall Share must not
be greater than 100
Annexure III: Exception – Error Code and Description for Security Interest
Table 14: Error Code and Description for Security Interest
SR NO ERROR CODE ERROR MESSAGE DESCRIPTION
1 1002 Action ID is invalid URL/Service name is incorrect.
2 4284 Access denied Auth type did not match
3 15000 Internal Server Error Occurred. Exception occurred as Channel Key is invalid.
Please try after some time.
4 70007 Failure while processing API request API Request is incorrect/ API Request
structure is incorrect/ API Request is not
encrypted properly.
5 8726 Unsuccessful Login! Please try to API Login Id is invalid.

Login again.
6 21001 Request Json didn't pass required Server side validation error. Request Json
validations didn't pass required validations.
7 41901 Something went wrong while No signature attached with the requesthash
verifying your Digital Signature.
Please try again.
8 41902 Digital Signature Verification Failed. Digital Signature hash verification failed while
verifying Security Interest digitally signed
hash.
9 41903 Your Digital Signature has been Your Digital Signature has been revoked.
revoked.
10 41904 Your Digital Signature has expired. User Digital Signature has expired.
11 70001 Failure while decrypting request API Request payload is incorrect/ API Request
payload payload is not encrypted properly.
12 21010 Entity has insufficient Balance Entity has insufficient balance (In case of UAT
testing, kindly connect with Technical Team
CERSAI).

CERSAI2.0 - API Specifications Document - v1 - 6

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

CERSAI2.0 - API Specifications Document - v1 - 6

Uploaded by

Copyright:

Available Formats

CERSAI 2.

TATA Consultancy Services Ltd.

Tata Code of Conduct

Document Revision History

Version No. Date Revision/Changes Author Reviewer

September Updated API Registration steps and Added API Vibha

Tata Code of Conduct ........................................................................................................................................ 2

Document Revision History ............................................................................................................................... 3

List of Abbreviation ............................................................................................................................................ 6

Consuming the APIs ........................................................................................................................................... 9

4. Steps for Registration for API .............................................................................................................. 10

5. Steps for Amendment of API ............................................................................................................... 11

6. Registration of Security Interest API ................................................................................................... 13

API Request (Encrypted) ..................................................................................................................................13

API Request (Un-encrypted) ............................................................................................................................14

API Request Attributes .....................................................................................................................................18

API Response (Encrypted) ................................................................................................................................23

API Response (Un-encrypted) ..........................................................................................................................25

API Response Attributes ..................................................................................................................................28

API Server Side Validation Error Response (Encrypted) ..................................................................................29

API API Server Side Validation Error Response (Un-encrypted) ......................................................................30

API Response Attributes ..................................................................................................................................30

Annexure I: Sample Requests and Responses ................................................................................................ 32

Table 1: List of Abbreviations ....................................................................................................................................... 6

Table 4: Server Side Validation Error API Response Attributes .................................................................................. 30

Table 5: Field Validation for Security Interest .......................................................................................................... 130

Table 6: Field Validation for Attachment Order ....................................................................................................... 133

Table 7: Field Validation for Immovable Assets ....................................................................................................... 135

Table 8: Field Validation for Movable Assets ........................................................................................................... 142

Table 9: Field Validation for Intangible Assets ......................................................................................................... 147

Table 10: Field Validation for Borrowers .................................................................................................................. 153

Table 11: Field Validation for Asset Owner .............................................................................................................. 162

Table 12: Field Validation for Charge Holder ............................................................................................................ 170

Table 13: Field Validation for Consortium ................................................................................................................ 173

Table 1: List of Abbreviations

Abbreviation Expanded Form

1. Consumer entity must be a registered entity in the Central Registry portal.

Consuming the APIs

4. Steps for Registration for API

4.5 Click on Submit button once data is entered.

5. Steps for Amendment of API

5.1 OpenURL: -https://www.qa.cersai.org.in/CERSAI/home.prg

5.2 Login using User ID and Password of Primary User Admin.

5.5 Click on Submit button once data is entered.

5.8 Form will open, if all fields are selected to amend.

5.9 Click on Submit button once data is entered.

5.10 User will get the following message:

6. Registration of Security Interest API

API Request (Encrypted)

API Request (Un-encrypted)

API Request Attributes

Sr. Attribute Name Data Is Remarks

Sr. Attribute Name Data Is Remarks

Sr. Attribute Name Data Is Remarks

Sr. Attribute Name Data Is Remarks

Sr. Attribute Name Data Is Remarks

API Response (Encrypted)

Kindly include following line, in case user is using java:

StringEscapeUtils.unescapeHtml( “<Decrypted response in HTML encoded format>”);

API Response (Un-encrypted)

• API Response: De-Dup Status “MF”

API Response Attributes