Application - API Specifications
Body
Responses
201
success
*/*
400
application(s) creation failed
*/*
post
/application/v1/createPOST /application/v1/create HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 2246
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"uuid": "text",
"userName": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"tenantId": "text",
"id": "text",
"name": "text",
"description": "text"
}
],
"salutation": "text",
"name": "text",
"gender": "text",
"alternateMobileNumber": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"locale": "text",
"type": "text",
"accountLocked": true,
"accountLockedDate": 1,
"fatherOrHusbandName": "text",
"relationship": "text",
"signature": "text",
"bloodGroup": "text",
"photo": "text",
"identificationMark": "text",
"createdBy": 1,
"password": "text",
"otpReference": "text",
"lastModifiedBy": 1,
"createdDate": "2025-11-08",
"lastModifiedDate": "2025-11-08",
"dob": 1,
"pwdExpiryDate": 1
}
},
"application": {
"tenantId": "text",
"caseId": "text",
"filingNumber": "text",
"cnrNumber": "text",
"referenceId": "123e4567-e89b-12d3-a456-426614174000",
"createdDate": 1,
"createdBy": "123e4567-e89b-12d3-a456-426614174000",
"onBehalfOf": [
"123e4567-e89b-12d3-a456-426614174000"
],
"applicationType": "text",
"applicationNumber": "Application 1 of the year 2024",
"applicationCMPNumber": "CMP/1/2024",
"issuedBy": {
"benchID": "text",
"judgeID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"courtID": "text"
},
"reasonForApplication": "text",
"applicationDetails": {},
"status": "text",
"comment": [
{
"tenantId": "text",
"individualId": "text",
"comment": "text",
"isActive": true,
"additionalDetails": "text",
"auditdetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"isActive": true,
"statuteSection": null,
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"additionalDetails": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"workflow": {
"action": "text",
"comment": "text",
"assignees": [
"text"
],
"status": "text",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
}
}
}{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"application": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"tenantId": "text",
"caseId": "text",
"filingNumber": "text",
"cnrNumber": "text",
"referenceId": "123e4567-e89b-12d3-a456-426614174000",
"createdDate": 1,
"createdBy": "123e4567-e89b-12d3-a456-426614174000",
"onBehalfOf": [
"123e4567-e89b-12d3-a456-426614174000"
],
"applicationType": "text",
"applicationNumber": "Application 1 of the year 2024",
"applicationCMPNumber": "CMP/1/2024",
"issuedBy": {
"benchID": "text",
"judgeID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"courtID": "text"
},
"reasonForApplication": "text",
"applicationDetails": {},
"status": "text",
"comment": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"tenantId": "text",
"individualId": "text",
"comment": "text",
"isActive": true,
"additionalDetails": "text",
"auditdetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"isActive": true,
"statuteSection": null,
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"additionalDetails": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"workflow": {
"action": "text",
"comment": "text",
"assignees": [
"text"
],
"status": "text",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
}
}
}Body
Responses
200
ResponseInfo with application(s) updated successfully
*/*
400
application(s) update failed
*/*
post
/application/v1/updatePOST /application/v1/update HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 2246
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"uuid": "text",
"userName": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"tenantId": "text",
"id": "text",
"name": "text",
"description": "text"
}
],
"salutation": "text",
"name": "text",
"gender": "text",
"alternateMobileNumber": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"locale": "text",
"type": "text",
"accountLocked": true,
"accountLockedDate": 1,
"fatherOrHusbandName": "text",
"relationship": "text",
"signature": "text",
"bloodGroup": "text",
"photo": "text",
"identificationMark": "text",
"createdBy": 1,
"password": "text",
"otpReference": "text",
"lastModifiedBy": 1,
"createdDate": "2025-11-08",
"lastModifiedDate": "2025-11-08",
"dob": 1,
"pwdExpiryDate": 1
}
},
"application": {
"tenantId": "text",
"caseId": "text",
"filingNumber": "text",
"cnrNumber": "text",
"referenceId": "123e4567-e89b-12d3-a456-426614174000",
"createdDate": 1,
"createdBy": "123e4567-e89b-12d3-a456-426614174000",
"onBehalfOf": [
"123e4567-e89b-12d3-a456-426614174000"
],
"applicationType": "text",
"applicationNumber": "Application 1 of the year 2024",
"applicationCMPNumber": "CMP/1/2024",
"issuedBy": {
"benchID": "text",
"judgeID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"courtID": "text"
},
"reasonForApplication": "text",
"applicationDetails": {},
"status": "text",
"comment": [
{
"tenantId": "text",
"individualId": "text",
"comment": "text",
"isActive": true,
"additionalDetails": "text",
"auditdetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"isActive": true,
"statuteSection": null,
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"additionalDetails": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"workflow": {
"action": "text",
"comment": "text",
"assignees": [
"text"
],
"status": "text",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
}
}
}{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"application": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"tenantId": "text",
"caseId": "text",
"filingNumber": "text",
"cnrNumber": "text",
"referenceId": "123e4567-e89b-12d3-a456-426614174000",
"createdDate": 1,
"createdBy": "123e4567-e89b-12d3-a456-426614174000",
"onBehalfOf": [
"123e4567-e89b-12d3-a456-426614174000"
],
"applicationType": "text",
"applicationNumber": "Application 1 of the year 2024",
"applicationCMPNumber": "CMP/1/2024",
"issuedBy": {
"benchID": "text",
"judgeID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"courtID": "text"
},
"reasonForApplication": "text",
"applicationDetails": {},
"status": "text",
"comment": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"tenantId": "text",
"individualId": "text",
"comment": "text",
"isActive": true,
"additionalDetails": "text",
"auditdetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"isActive": true,
"statuteSection": null,
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"additionalDetails": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"workflow": {
"action": "text",
"comment": "text",
"assignees": [
"text"
],
"status": "text",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
}
}
}Gets the list of Application(s)
Body
Responses
200
ResponseInfo with application(s) search successfully
*/*
400
application(s) get failed
*/*
post
/application/v1/searchPOST /application/v1/search HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 1280
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"uuid": "text",
"userName": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"tenantId": "text",
"id": "text",
"name": "text",
"description": "text"
}
],
"salutation": "text",
"name": "text",
"gender": "text",
"alternateMobileNumber": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"locale": "text",
"type": "text",
"accountLocked": true,
"accountLockedDate": 1,
"fatherOrHusbandName": "text",
"relationship": "text",
"signature": "text",
"bloodGroup": "text",
"photo": "text",
"identificationMark": "text",
"createdBy": 1,
"password": "text",
"otpReference": "text",
"lastModifiedBy": 1,
"createdDate": "2025-11-08",
"lastModifiedDate": "2025-11-08",
"dob": 1,
"pwdExpiryDate": 1
}
},
"criteria": {
"filingNumber": "text",
"owner": null,
"cnrNumber": "text",
"applicationNumber": "text",
"applicationCMPNumber": "text",
"applicationType": "text",
"status": "text",
"id": "text",
"tenantId": "text"
},
"pagination": {
"limit": 10,
"offSet": 0,
"sortBy": "text",
"order": {}
}
}{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"TotalCount": 1,
"applicationList": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"tenantId": "text",
"caseId": "text",
"filingNumber": "text",
"cnrNumber": "text",
"referenceId": "123e4567-e89b-12d3-a456-426614174000",
"createdDate": 1,
"createdBy": "123e4567-e89b-12d3-a456-426614174000",
"onBehalfOf": [
"123e4567-e89b-12d3-a456-426614174000"
],
"applicationType": "text",
"applicationNumber": "Application 1 of the year 2024",
"applicationCMPNumber": "CMP/1/2024",
"issuedBy": {
"benchID": "text",
"judgeID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"courtID": "text"
},
"reasonForApplication": "text",
"applicationDetails": {},
"status": "text",
"comment": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"tenantId": "text",
"individualId": "text",
"comment": "text",
"isActive": true,
"additionalDetails": "text",
"auditdetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
],
"isActive": true,
"statuteSection": null,
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
],
"additionalDetails": {},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
},
"workflow": {
"action": "text",
"comment": "text",
"assignees": [
"text"
],
"status": "text",
"documents": [
{
"id": "text",
"documentType": "text",
"fileStore": "text",
"documentUid": "text",
"additionalDetails": {}
}
]
}
}
]
}Body
Responses
201
ResponseInfo with application(s) updated successfully
*/*
400
failed to validate Application
*/*
post
/application/v1/existsPOST /application/v1/exists HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 1125
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"uuid": "text",
"userName": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"tenantId": "text",
"id": "text",
"name": "text",
"description": "text"
}
],
"salutation": "text",
"name": "text",
"gender": "text",
"alternateMobileNumber": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"locale": "text",
"type": "text",
"accountLocked": true,
"accountLockedDate": 1,
"fatherOrHusbandName": "text",
"relationship": "text",
"signature": "text",
"bloodGroup": "text",
"photo": "text",
"identificationMark": "text",
"createdBy": 1,
"password": "text",
"otpReference": "text",
"lastModifiedBy": 1,
"createdDate": "2025-11-08",
"lastModifiedDate": "2025-11-08",
"dob": 1,
"pwdExpiryDate": 1
}
},
"applicationList": [
{
"filingNumber": "text",
"cnrNumber": "text",
"applicationNumber": "text",
"exists": true
}
]
}{
"responseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"applicationList": {
"filingNumber": "text",
"cnrNumber": "text",
"applicationNumber": "text",
"exists": true
}
}Body
Responses
201
success
*/*
400
application(s) creation failed
*/*
post
/application/v1/addcommentPOST /application/v1/addcomment HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 1285
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"id": 1,
"uuid": "text",
"userName": "text",
"mobileNumber": "text",
"emailId": "text",
"roles": [
{
"tenantId": "text",
"id": "text",
"name": "text",
"description": "text"
}
],
"salutation": "text",
"name": "text",
"gender": "text",
"alternateMobileNumber": "text",
"altContactNumber": "text",
"pan": "text",
"aadhaarNumber": "text",
"permanentAddress": "text",
"permanentCity": "text",
"permanentPincode": "text",
"correspondenceCity": "text",
"correspondencePincode": "text",
"correspondenceAddress": "text",
"active": true,
"locale": "text",
"type": "text",
"accountLocked": true,
"accountLockedDate": 1,
"fatherOrHusbandName": "text",
"relationship": "text",
"signature": "text",
"bloodGroup": "text",
"photo": "text",
"identificationMark": "text",
"createdBy": 1,
"password": "text",
"otpReference": "text",
"lastModifiedBy": 1,
"createdDate": "2025-11-08",
"lastModifiedDate": "2025-11-08",
"dob": 1,
"pwdExpiryDate": 1
}
},
"applicationAddComment": {
"applicationNumber": "text",
"comment": [
{
"tenantId": "text",
"individualId": "text",
"comment": "text",
"isActive": true,
"additionalDetails": "text",
"auditdetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"applicationAddComment": {
"applicationNumber": "text",
"comment": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"tenantId": "text",
"individualId": "text",
"comment": "text",
"isActive": true,
"additionalDetails": "text",
"auditdetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}
}Last updated