Evidence - API Specifications

Upload artifacts that could potentially be accepted as evidence

post

API used to create a new artifact that could become evidence 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.

artifactobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/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",
      "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
      }
    },
    "artifact": {}
  }'

*/*

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "artifact": {},
  "pagination": {
    "limit": 1,
    "offSet": 1,
    "totalCount": 1,
    "sortBy": "text",
    "order": {
      "0": "a",
      "1": "s",
      "2": "c"
    }
  }
}

ResponseInfo with artifact(s) updated successfully

Update evidence request

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.

artifactobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/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",
      "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
      }
    },
    "artifact": {}
  }'

*/*

201

400

201

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "artifact": {},
  "pagination": {
    "limit": 1,
    "offSet": 1,
    "totalCount": 1,
    "sortBy": "text",
    "order": {
      "0": "a",
      "1": "s",
      "2": "c"
    }
  }
}

ResponseInfo with artifact(s) updated successfully

Search for artifacts

post

API used to search artifacts using search criteria

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.

tenantIdstringoptional

criteriaobjectoptional

the fields specified will be used in a logical AND condition

paginationobjectoptional

Pagination details

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/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",
      "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
      }
    },
    "tenantId": "text",
    "criteria": {
      "caseId": "text",
      "applicationId": "text",
      "owner": "123e4567-e89b-12d3-a456-426614174000",
      "filingNumber": "text",
      "artifactType": "text",
      "evidenceStatus": "text",
      "hearing": "text",
      "order": "text",
      "sourceId": "text",
      "sourceName": "text",
      "status": "text",
      "artifactNumber": "text"
    },
    "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"
  },
  "tenantId": "text",
  "artifacts": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenantId": "text",
      "artifactNumber": "text",
      "evidenceNumber": "text",
      "externalRefNumber": "text",
      "caseId": "text",
      "application": "text",
      "filingNumber": "text",
      "hearing": "text",
      "order": "text",
      "mediaType": "AUDIO, VIDEO, DOC",
      "artifactType": "AFFIDAVIT, DEPOSITION, SWORN_STATEMENT, OTHER etc..",
      "filingType": "master data values - caseFiling, application, direct",
      "sourceType": "COMPLAINANT, ACCUSED, COURT.",
      "sourceID": "text",
      "sourceName": "Mr. Sundar, Assistant DGP",
      "applicableTo": [
        "text"
      ],
      "createdDate": 1,
      "isActive": true,
      "isEvidence": true,
      "isVoid": true,
      "reason": "text",
      "status": "text",
      "file": {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      },
      "description": "text",
      "artifactDetails": {},
      "comments": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "tenantId": "text",
          "artifactId": "text",
          "individualId": "text",
          "comment": "text",
          "isActive": true,
          "additionalDetails": "text",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "additionalDetails": "text",
      "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": {}
          }
        ]
      }
    }
  ],
  "pagination": {
    "limit": 1,
    "offSet": 1,
    "totalCount": 1,
    "sortBy": "text",
    "order": {
      "0": "a",
      "1": "s",
      "2": "c"
    }
  }
}

ResponseInfo with artifacts matching search criteria

Add comment in artifacts

post

API used to add comment in artifacts

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.

evidenceAddCommentobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/addcomment' \
  --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
      }
    },
    "evidenceAddComment": {
      "tenantId": "text",
      "comment": [],
      "artifactNumber": "text"
    }
  }'

*/*

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "evidenceAddComment": {
    "tenantId": "text",
    "comment": [],
    "artifactNumber": "text"
  }
}

ResponseInfo with comment