Case - API Specifications

Create new case in the registry

post

Creates a new case in the case registry

Body

RequestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

caseone ofoptional

Case registry

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/case/v1/_create' \
  --header 'Content-Type: */*' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "case": {
      "tenantId": "text",
      "resolutionMechanism": "COURT, ADR.MEDIATION, ADR.CONCILIATION, ODR.ARBITRATION, Lok Adalat",
      "caseDescription": "text",
      "filingNumber": "KL-000001-2024",
      "courtCaseNumber": "CC/023443/2024 OR ST/1/2024",
      "cnrNumber": "PBJL01-123556-2024",
      "cmpNumber": "CMP/1/2024",
      "courtId": "KLKM52",
      "judgeId": "text",
      "stage": "text",
      "subStage": "text",
      "benchId": "text",
      "linkedCases": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "relationshipType": "PARENT, CHILD, PRIOR_APPEAL",
          "caseNumber": "text",
          "referenceUri": "text",
          "isActive": true,
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ],
          "additionalDetails": "text"
        }
      ],
      "filingDate": 1709542147,
      "judgementDate": 1,
      "advocateCount": 1,
      "registrationDate": 1,
      "caseDetails": {},
      "caseCategory": "CIVIL, CRIMINAL",
      "natureOfPleading": "Original Suit,Complaint,Interim Application,First Appeal,Second Appeal,Review,Revision,Reference",
      "statutesAndSections": [
        {
          "tenantId": "text",
          "statute": "text",
          "sections": [
            "text"
          ],
          "subsections": [
            "text"
          ],
          "additionalDetails": "text"
        }
      ],
      "litigants": [
        null
      ],
      "representatives": [
        null
      ],
      "status": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "remarks": "text",
      "outcome": "text",
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ]
      },
      "additionalDetails": {}
    }
  }'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "case": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "tenantId": "text",
    "resolutionMechanism": "COURT, ADR.MEDIATION, ADR.CONCILIATION, ODR.ARBITRATION, Lok Adalat",
    "caseTitle": "text",
    "caseDescription": "text",
    "filingNumber": "KL-000001-2024",
    "courtCaseNumber": "CC/023443/2024 OR ST/1/2024",
    "cnrNumber": "PBJL01-123556-2024",
    "cmpNumber": "CMP/1/2024",
    "accessCode": "text",
    "courtId": "KLKM52",
    "judgeId": "text",
    "stage": "text",
    "subStage": "text",
    "benchId": "text",
    "linkedCases": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "relationshipType": "PARENT, CHILD, PRIOR_APPEAL",
        "caseNumber": "text",
        "referenceUri": "text",
        "isActive": true,
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ],
        "additionalDetails": "text"
      }
    ],
    "filingDate": 1709542147,
    "judgementDate": 1,
    "advocateCount": 1,
    "registrationDate": 1,
    "caseDetails": {},
    "caseCategory": "CIVIL, CRIMINAL",
    "natureOfPleading": "Original Suit,Complaint,Interim Application,First Appeal,Second Appeal,Review,Revision,Reference",
    "statutesAndSections": [
      {
        "tenantId": "text",
        "statute": "text",
        "sections": [
          "text"
        ],
        "subsections": [
          "text"
        ],
        "additionalDetails": "text"
      }
    ],
    "litigants": [
      null
    ],
    "representatives": [
      null
    ],
    "status": "text",
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ],
    "remarks": "text",
    "outcome": "text",
    "workflow": {
      "action": "text",
      "comment": "text",
      "assignees": [
        "text"
      ]
    },
    "additionalDetails": {},
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

ResponseInfo with case groups created successfully

Update a court case

post

API to update the case. Updates can include workflow, attributes of the case and/or soft deletion.

Body

RequestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

caseone ofoptional

Case registry

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/case/v1/_update' \
  --header 'Content-Type: */*' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "case": {
      "tenantId": "text",
      "resolutionMechanism": "COURT, ADR.MEDIATION, ADR.CONCILIATION, ODR.ARBITRATION, Lok Adalat",
      "caseDescription": "text",
      "filingNumber": "KL-000001-2024",
      "courtCaseNumber": "CC/023443/2024 OR ST/1/2024",
      "cnrNumber": "PBJL01-123556-2024",
      "cmpNumber": "CMP/1/2024",
      "courtId": "KLKM52",
      "judgeId": "text",
      "stage": "text",
      "subStage": "text",
      "benchId": "text",
      "linkedCases": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "relationshipType": "PARENT, CHILD, PRIOR_APPEAL",
          "caseNumber": "text",
          "referenceUri": "text",
          "isActive": true,
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ],
          "additionalDetails": "text"
        }
      ],
      "filingDate": 1709542147,
      "judgementDate": 1,
      "advocateCount": 1,
      "registrationDate": 1,
      "caseDetails": {},
      "caseCategory": "CIVIL, CRIMINAL",
      "natureOfPleading": "Original Suit,Complaint,Interim Application,First Appeal,Second Appeal,Review,Revision,Reference",
      "statutesAndSections": [
        {
          "tenantId": "text",
          "statute": "text",
          "sections": [
            "text"
          ],
          "subsections": [
            "text"
          ],
          "additionalDetails": "text"
        }
      ],
      "litigants": [
        null
      ],
      "representatives": [
        null
      ],
      "status": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "remarks": "text",
      "outcome": "text",
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ]
      },
      "additionalDetails": {}
    }
  }'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "case": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "tenantId": "text",
    "resolutionMechanism": "COURT, ADR.MEDIATION, ADR.CONCILIATION, ODR.ARBITRATION, Lok Adalat",
    "caseTitle": "text",
    "caseDescription": "text",
    "filingNumber": "KL-000001-2024",
    "courtCaseNumber": "CC/023443/2024 OR ST/1/2024",
    "cnrNumber": "PBJL01-123556-2024",
    "cmpNumber": "CMP/1/2024",
    "accessCode": "text",
    "courtId": "KLKM52",
    "judgeId": "text",
    "stage": "text",
    "subStage": "text",
    "benchId": "text",
    "linkedCases": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "relationshipType": "PARENT, CHILD, PRIOR_APPEAL",
        "caseNumber": "text",
        "referenceUri": "text",
        "isActive": true,
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ],
        "additionalDetails": "text"
      }
    ],
    "filingDate": 1709542147,
    "judgementDate": 1,
    "advocateCount": 1,
    "registrationDate": 1,
    "caseDetails": {},
    "caseCategory": "CIVIL, CRIMINAL",
    "natureOfPleading": "Original Suit,Complaint,Interim Application,First Appeal,Second Appeal,Review,Revision,Reference",
    "statutesAndSections": [
      {
        "tenantId": "text",
        "statute": "text",
        "sections": [
          "text"
        ],
        "subsections": [
          "text"
        ],
        "additionalDetails": "text"
      }
    ],
    "litigants": [
      null
    ],
    "representatives": [
      null
    ],
    "status": "text",
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ],
    "remarks": "text",
    "outcome": "text",
    "workflow": {
      "action": "text",
      "comment": "text",
      "assignees": [
        "text"
      ]
    },
    "additionalDetails": {},
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

ResponseInfo with case details updated successfully

Edit a court case

post

API to Edit the case.

Body

RequestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

caseone ofoptional

Case registry

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/case/v1/admin/edit_case' \
  --header 'Content-Type: */*' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "case": {
      "tenantId": "text",
      "resolutionMechanism": "COURT, ADR.MEDIATION, ADR.CONCILIATION, ODR.ARBITRATION, Lok Adalat",
      "caseDescription": "text",
      "filingNumber": "KL-000001-2024",
      "courtCaseNumber": "CC/023443/2024 OR ST/1/2024",
      "cnrNumber": "PBJL01-123556-2024",
      "cmpNumber": "CMP/1/2024",
      "courtId": "KLKM52",
      "judgeId": "text",
      "stage": "text",
      "subStage": "text",
      "benchId": "text",
      "linkedCases": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "relationshipType": "PARENT, CHILD, PRIOR_APPEAL",
          "caseNumber": "text",
          "referenceUri": "text",
          "isActive": true,
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ],
          "additionalDetails": "text"
        }
      ],
      "filingDate": 1709542147,
      "judgementDate": 1,
      "advocateCount": 1,
      "registrationDate": 1,
      "caseDetails": {},
      "caseCategory": "CIVIL, CRIMINAL",
      "natureOfPleading": "Original Suit,Complaint,Interim Application,First Appeal,Second Appeal,Review,Revision,Reference",
      "statutesAndSections": [
        {
          "tenantId": "text",
          "statute": "text",
          "sections": [
            "text"
          ],
          "subsections": [
            "text"
          ],
          "additionalDetails": "text"
        }
      ],
      "litigants": [
        null
      ],
      "representatives": [
        null
      ],
      "status": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "remarks": "text",
      "outcome": "text",
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ]
      },
      "additionalDetails": {}
    }
  }'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "case": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "tenantId": "text",
    "resolutionMechanism": "COURT, ADR.MEDIATION, ADR.CONCILIATION, ODR.ARBITRATION, Lok Adalat",
    "caseTitle": "text",
    "caseDescription": "text",
    "filingNumber": "KL-000001-2024",
    "courtCaseNumber": "CC/023443/2024 OR ST/1/2024",
    "cnrNumber": "PBJL01-123556-2024",
    "cmpNumber": "CMP/1/2024",
    "accessCode": "text",
    "courtId": "KLKM52",
    "judgeId": "text",
    "stage": "text",
    "subStage": "text",
    "benchId": "text",
    "linkedCases": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "relationshipType": "PARENT, CHILD, PRIOR_APPEAL",
        "caseNumber": "text",
        "referenceUri": "text",
        "isActive": true,
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ],
        "additionalDetails": "text"
      }
    ],
    "filingDate": 1709542147,
    "judgementDate": 1,
    "advocateCount": 1,
    "registrationDate": 1,
    "caseDetails": {},
    "caseCategory": "CIVIL, CRIMINAL",
    "natureOfPleading": "Original Suit,Complaint,Interim Application,First Appeal,Second Appeal,Review,Revision,Reference",
    "statutesAndSections": [
      {
        "tenantId": "text",
        "statute": "text",
        "sections": [
          "text"
        ],
        "subsections": [
          "text"
        ],
        "additionalDetails": "text"
      }
    ],
    "litigants": [
      null
    ],
    "representatives": [
      null
    ],
    "status": "text",
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ],
    "remarks": "text",
    "outcome": "text",
    "workflow": {
      "action": "text",
      "comment": "text",
      "assignees": [
        "text"
      ]
    },
    "additionalDetails": {},
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

ResponseInfo with case details edited successfully

returns list of cases with public fields

post

This API is for summary search and will only return the public fields for a case. While the API will check the authentication token, it is only to ensure that it is being called from an authenticated source. The individualId from the token will not be used for the case search.

TenantId and at least one of caseId or Filing or CNR number is mandatory. If nothing is specified, the API will fail. It will return zero cases if no matching case is found or at most one case.

The response will be a union (logical OR) of all the parameters sent in for the search. The API will also de-duplicate the responses before sharing the result back.

The typical usage scenario is where a person is request case details for a case he/she is not related to, i.e neither is a party nor has any required authorization (RBAC), for example, when trying to join a case.

Body

requestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

criteriaone ofoptional

paginationobjectoptional

Pagination details

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/case/v1/search/_summary' \
  --header 'Content-Type: */*' \
  --data '{
    "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-03-25",
        "lastModifiedDate": "2025-03-25",
        "dob": 1,
        "pwdExpiryDate": 1
      }
    },
    "criteria": {
      "tenantId": "text",
      "caseId": [
        "text"
      ],
      "filingNumber": [
        "text"
      ],
      "cnrNumber": [
        "text"
      ]
    },
    "pagination": {
      "limit": 1,
      "offSet": 1,
      "sortBy": "text",
      "order": {
        "0": "a",
        "1": "s",
        "2": "c"
      }
    }
  }'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "cases": [
    {
      "tenantId": "text",
      "caseTitle": "text",
      "filingDate": 1709542147,
      "statutesAndSections": "NIA 138, 142(1)(a), 145; CrPC 100, 402(a)",
      "stage": "Pre-Trial, Trial, Post-Trial",
      "subStage": "Filing, Cognizance, Appearance, Evidence, Judgement etc.",
      "outcome": "text",
      "courtId": "KLKM52",
      "registrationDate": 1727526615632,
      "registrationNumber": "CMP/1/2024",
      "litigants": [
        {
          "partyCategory": "INDIVIDUAL, ORGANISATION",
          "partyType": [
            "complainant.primary",
            "complainant.additional",
            "respondent.primary"
          ],
          "individualId": "text",
          "individualName": "text",
          "organisationID": "text",
          "isPartyInPerson": true
        }
      ],
      "representatives": [
        {
          "partyId": "text",
          "advocateId": "text",
          "advocateType": "primary"
        }
      ],
      "judge": {
        "id": "text",
        "name": "text",
        "designation": "text"
      }
    }
  ],
  "pagination": {
    "limit": 1,
    "offSet": 1,
    "totalCount": 1,
    "sortBy": "text",
    "order": {
      "0": "a",
      "1": "s",
      "2": "c"
    }
  }
}

ResponseInfo with case groups created successfully

returns a list of case with public fields based on filters and is authenticated

post

This API is for summary search and will only return the public fields for a case. While the API will check the authentication token, it is only to ensure that it is being called from an authenticated source. The individualId from the token will not be used for the case search.

TenantId and at least one of caseId or Filing or CNR number is mandatory. If nothing is specified, the API will fail. It will return zero cases if no matching case is found or at most one case.

The response will be a union (logical OR) of all the parameters sent in for the search. The API will also de-duplicate the responses before sharing the result back.

This will typically be used by a person who is either a party to the case (litigant, advocate, judge) or has authorized (RBAC) access (clerk, scrutiny officer) etc. A typical use case is getting a list of "My Case" for a person's home screen

Body

requestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

criteriaobjectoptional

paginationobjectoptional

Pagination details

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/case/v1/search/_list' \
  --header 'Content-Type: */*' \
  --data '{
    "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-03-25",
        "lastModifiedDate": "2025-03-25",
        "dob": 1,
        "pwdExpiryDate": 1
      }
    },
    "criteria": {
      "caseId": "text",
      "tenantId": "text",
      "cnrNumber": "text",
      "filingNumber": "text",
      "courtId": "text",
      "stage": [
        "text"
      ],
      "subStage": [
        "text"
      ],
      "outcome": [
        "text"
      ],
      "status": [
        "text"
      ],
      "filingFromDate": 1,
      "filingToDate": 1,
      "registrationFromDate": 1,
      "registrationToDate": 1
    },
    "pagination": {
      "limit": 1,
      "offSet": 1,
      "sortBy": "text",
      "order": {
        "0": "a",
        "1": "s",
        "2": "c"
      }
    }
  }'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "cases": [
    {
      "tenantId": "text",
      "caseTitle": "text",
      "filingDate": 1709542147,
      "statutesAndSections": "NIA 138, 142(1)(a), 145; CrPC 100, 402(a)",
      "stage": "Pre-Trial, Trial, Post-Trial",
      "subStage": "Filing, Cognizance, Appearance, Evidence, Judgement etc.",
      "outcome": "text",
      "courtId": "KLKM52",
      "registrationDate": 1727526615632,
      "registrationNumber": "CMP/1/2024",
      "litigants": [
        {
          "partyCategory": "INDIVIDUAL, ORGANISATION",
          "partyType": [
            "complainant.primary",
            "complainant.additional",
            "respondent.primary"
          ],
          "individualId": "text",
          "individualName": "text",
          "organisationID": "text",
          "isPartyInPerson": true
        }
      ],
      "representatives": [
        {
          "partyId": "text",
          "advocateId": "text",
          "advocateType": "primary"
        }
      ],
      "judge": {
        "id": "text",
        "name": "text",
        "designation": "text"
      }
    }
  ],
  "pagination": {
    "limit": 1,
    "offSet": 1,
    "totalCount": 1,
    "sortBy": "text",
    "order": {
      "0": "a",
      "1": "s",
      "2": "c"
    }
  }
}

ResponseInfo with case groups created successfully

Search for cases

post

This API deals with getting detailed information about a case, it will be access controlled. The basic premise will be that all validations are mandatory based on the logged in person’s individualID/authentication token, and this should not be sent as input parameter (as then a person can login and then request details by passing anyone else’s ID). In addition, search will always include tenancy as a parameter. Case details will be visible using the following logic.

Authorised roles to view case details are as follows. These roles will be allowed to invoke the above API. The individualId should have any one of these roles, along with additional validations as mentioned below.

  CASE_APPROVER-- Mostly assigned to the Judge who will look at the case detail and approve and later will preside over the case, and hence will be assigned to the case (via courtId and judgeId fields). Hence while this role is authorised, additional things to check will be that the person with this role is an Employee and also is assigned to the case as the Judge.
  CASE_REVIEWER-- Mostly assigned to the scrutiny officer. A person with this role, is not expected to be party to the case, hence this role will grant direct access to any case for review. The access can be additionally controlled by tenancy.
  CASE_EDITOR-- Mostly assigned to bench clerk and also complainant and the representing advocate. The validation will need to check that the person having this role is either a bench clerk i.e. an employee or if citizen, then is party to the case as either a complainant or representing advocate or respondent or their representing advocate or advocate clerk.

  Note-- CASE_CREATOR-- Litigants and Advocates can create a case. Once created, they will become party to the case and hence for search, they will need to be party to the case to be able to search. CASE_CREATOR will not be a role authorised to invoke this API.

The response will be a union (logical OR) of all the parameters sent in for the search. The API will also de-duplicate the responses before sharing the result back.

Body

RequestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

criteriaobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/case/v1/search/_details' \
  --header 'Content-Type: */*' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "criteria": {
      "caseId": null,
      "defaultFields": null,
      "cnrNumber": null,
      "filingNumber": null,
      "outcome": [
        null
      ],
      "courtCaseNumber": null,
      "filingFromDate": 1,
      "filingToDate": 1,
      "registrationFromDate": 1,
      "registrationToDate": 1,
      "judgeId": null,
      "stage": [
        "text"
      ],
      "subStage": "text",
      "litigantId": null,
      "advocateId": null,
      "courtId": null,
      "status": [
        null
      ]
    }
  }'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "cases": [
    {
      "caseId": null,
      "defaultFields": null,
      "cnrNumber": null,
      "filingNumber": null,
      "outcome": [
        null
      ],
      "courtCaseNumber": null,
      "filingFromDate": 1,
      "filingToDate": 1,
      "registrationFromDate": 1,
      "registrationToDate": 1,
      "judgeId": null,
      "stage": [
        "text"
      ],
      "subStage": "text",
      "litigantId": null,
      "advocateId": null,
      "courtId": null,
      "status": [
        null
      ]
    }
  ],
  "pagination": {
    "limit": 1,
    "offSet": 1,
    "totalCount": 1,
    "sortBy": "text",
    "order": {
      "0": "a",
      "1": "s",
      "2": "c"
    }
  }
}

ResponseInfo with cases matching search criteria

verify the access code

post

Body

RequestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

codeobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/case/v1/_verifycode' \
  --header 'Content-Type: */*' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "code": {
      "tenantId": "text",
      "code": "text",
      "filingNumber": "text"
    }
  }'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "isValid": true
}

ResponseInfo with enriched litigants and representatives

litigants or representatives who want to join a existing case will use this API

post

Body

RequestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/case/v1/_joincase' \
  --header 'Content-Type: */*' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    }
  }'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "isVerified": true
}

ResponseInfo with enriched litigants and representatives

check if a specific case exists by using case number

post

Body

RequestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

criteriaobject[]optional

paginationobjectoptional

Pagination details

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/case/v1/_exists' \
  --header 'Content-Type: */*' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "criteria": [
      {
        "tenantId": "text",
        "caseId": "text",
        "cnrNumber": "text",
        "filingNumber": "text",
        "exists": true
      }
    ],
    "pagination": {
      "limit": 1,
      "offSet": 1,
      "sortBy": "text",
      "order": {
        "0": "a",
        "1": "s",
        "2": "c"
      }
    }
  }'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "criteria": [
    {
      "tenantId": "text",
      "caseId": "text",
      "cnrNumber": "text",
      "filingNumber": "text",
      "exists": true
    }
  ],
  "pagination": {
    "limit": 1,
    "offSet": 1,
    "totalCount": 1,
    "sortBy": "text",
    "order": {
      "0": "a",
      "1": "s",
      "2": "c"
    }
  }
}

ResponseInfo with cases matching the search criteria. Empty array is returned in case no cases match the search criteria.

API to add a witness to a case

post

API to add a witness to a case

Body

requestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

witnessesone of[]optional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/case/witness/v1/_create' \
  --header 'Content-Type: */*' \
  --data '{
    "requestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "witnesses": [
      null
    ]
  }'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "witnesses": [
    null
  ]
}

ResponseInfo with witness mapping created successfully

API to update or remove a witness to a case. Update is accomplished through the isActive flag.

post

API to update or remove a witness to a case

Body

requestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

witnessesone of[]optional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/case/witness/v1/_update' \
  --header 'Content-Type: */*' \
  --data '{
    "requestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "witnesses": [
      null
    ]
  }'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "witnesses": [
    null
  ]
}

ResponseInfo with witness update successfully executed

API to search for a witness in a case.

post

API to search for a witness in a case

Body

RequestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

searchCriteriaobject[]optional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/case/witness/v1/_search' \
  --header 'Content-Type: */*' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "searchCriteria": [
      {
        "caseId": "text",
        "individualId": "text",
        "includeInactive": true
      }
    ]
  }'

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "witnesses": [
    null
  ]
}

ResponseInfo with witness search results, if any. Empty array if no witnesses matching the search criteria are found.