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

*/*

artifactobjectOptional

Responses

200

ResponseInfo with artifact(s) updated successfully

*/*

400

Artifact(s) creation failed

*/*

post

/v1/_create

HTTPcURLJavaScriptPython

POST /v1/_create HTTP/1.1
Host: 
Content-Type: */*
Accept: */*
Content-Length: 1035

{
  "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
    }
  },
  "artifact": {}
}

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

Update evidence request

post

Body

*/*

artifactobjectOptional

Responses

201

ResponseInfo with artifact(s) updated successfully

*/*

400

artifact(s) update failed

*/*

post

/v1/_update

HTTPcURLJavaScriptPython

POST /v1/_update HTTP/1.1
Host: 
Content-Type: */*
Accept: */*
Content-Length: 1035

{
  "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
    }
  },
  "artifact": {}
}

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

Search for artifacts

post

API used to search artifacts using search criteria

Body

*/*

tenantIdstringOptional

Responses

200

ResponseInfo with artifacts matching search criteria

*/*

400

Artifacts search failed. Refer to the response body for specifics.

*/*

post

/v1/_search

HTTPcURLJavaScriptPython

POST /v1/_search HTTP/1.1
Host: 
Content-Type: */*
Accept: */*
Content-Length: 1380

{
  "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
    }
  },
  "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": 10,
    "offSet": 0,
    "sortBy": "text",
    "order": {}
  }
}

{
  "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": false,
      "isVoid": false,
      "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": 10,
    "offSet": 0,
    "totalCount": 1,
    "sortBy": "text",
    "order": {}
  }
}

Add comment in artifacts

post

API used to add comment in artifacts

Body

*/*

Responses

200

ResponseInfo with comment

*/*

400

Add comment failed. Refer to the response body for specifics.

*/*

post

/v1/addcomment

HTTPcURLJavaScriptPython

POST /v1/addcomment HTTP/1.1
Host: 
Content-Type: */*
Accept: */*
Content-Length: 1099

{
  "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
    }
  },
  "evidenceAddComment": {
    "tenantId": "text",
    "comment": [],
    "artifactNumber": "text"
  }
}

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