Advocate - API Specifications

Register a new advocate

post

API to register and verify an advocate.

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.

advocateobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/advocate/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
      }
    },
    "advocate": {
      "tenantId": "text",
      "applicationNumber": "text",
      "barRegistrationNumber": "text",
      "advocateType": "PROSECUTOR, PUBLIC DEFENDER",
      "organisationID": "123e4567-e89b-12d3-a456-426614174000",
      "individualId": "text",
      "status": "text",
      "isActive": true,
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ],
        "status": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      },
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "additionalDetails": {}
    }
  }'

201

400

201

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "advocates": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenantId": "text",
      "applicationNumber": "text",
      "barRegistrationNumber": "text",
      "advocateType": "PROSECUTOR, PUBLIC DEFENDER",
      "organisationID": "123e4567-e89b-12d3-a456-426614174000",
      "individualId": "text",
      "status": "text",
      "isActive": true,
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ],
        "status": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      },
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "additionalDetails": {}
    }
  ]
}

ResponseInfo with advocate info updated successfully

Update advocate requests

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.

advocateobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/advocate/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
      }
    },
    "advocate": {
      "tenantId": "text",
      "applicationNumber": "text",
      "barRegistrationNumber": "text",
      "advocateType": "PROSECUTOR, PUBLIC DEFENDER",
      "organisationID": "123e4567-e89b-12d3-a456-426614174000",
      "individualId": "text",
      "status": "text",
      "isActive": true,
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ],
        "status": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      },
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "additionalDetails": {}
    }
  }'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "advocates": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenantId": "text",
      "applicationNumber": "text",
      "barRegistrationNumber": "text",
      "advocateType": "PROSECUTOR, PUBLIC DEFENDER",
      "organisationID": "123e4567-e89b-12d3-a456-426614174000",
      "individualId": "text",
      "status": "text",
      "isActive": true,
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ],
        "status": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      },
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "additionalDetails": {}
    }
  ]
}

ResponseInfo with advocate data updated successfully

search for advocates using the status of their registration

post

Query parameters

statusstringrequired

status of advocate registration being searched

tenantIdstringrequired

Search by tenantId

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/advocate/v1/status/_search?status=text&tenantId=text'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "advocates": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenantId": "text",
      "applicationNumber": "text",
      "barRegistrationNumber": "text",
      "advocateType": "PROSECUTOR, PUBLIC DEFENDER",
      "organisationID": "123e4567-e89b-12d3-a456-426614174000",
      "individualId": "text",
      "status": "text",
      "isActive": true,
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ],
        "status": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      },
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "additionalDetails": {}
    }
  ]
}

ResponseInfo with advocates matching search criteria

search for advocates using the applicationNumber of their registration

post

Query parameters

applicationNumberstringrequired

applicationNumber of advocate registration being searched

tenantIdstringrequired

Search by tenantId

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/advocate/v1/applicationnumber/_search?applicationNumber=text&tenantId=text'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "advocates": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenantId": "text",
      "applicationNumber": "text",
      "barRegistrationNumber": "text",
      "advocateType": "PROSECUTOR, PUBLIC DEFENDER",
      "organisationID": "123e4567-e89b-12d3-a456-426614174000",
      "individualId": "text",
      "status": "text",
      "isActive": true,
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ],
        "status": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      },
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "additionalDetails": {}
    }
  ]
}

ResponseInfo with advocates matching search criteria

Search for registered advocates

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.

tenantIdstringoptional

criteriaobject[]optional

the fields specified will be used in a logical AND condition

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/advocate/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": [
      {
        "id": "text",
        "barRegistrationNumber": "text",
        "applicationNumber": "text",
        "individualId": "text",
        "responseList": [
          {
            "tenantId": "text",
            "applicationNumber": "text",
            "barRegistrationNumber": "text",
            "advocateType": "PROSECUTOR, PUBLIC DEFENDER",
            "organisationID": "123e4567-e89b-12d3-a456-426614174000",
            "individualId": "text",
            "status": "text",
            "isActive": true,
            "workflow": {
              "action": "text",
              "comment": "text",
              "assignees": [
                "text"
              ],
              "status": "text",
              "documents": [
                {
                  "id": "text",
                  "documentType": "text",
                  "fileStore": "text",
                  "documentUid": "text",
                  "additionalDetails": {}
                }
              ]
            },
            "documents": [
              {
                "id": "text",
                "documentType": "text",
                "fileStore": "text",
                "documentUid": "text",
                "additionalDetails": {}
              }
            ],
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text",
              "createdTime": 1,
              "lastModifiedTime": 1
            },
            "additionalDetails": {}
          }
        ]
      }
    ]
  }'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "advocates": [
    {
      "id": "text",
      "barRegistrationNumber": "text",
      "applicationNumber": "text",
      "individualId": "text",
      "responseList": [
        {
          "tenantId": "text",
          "applicationNumber": "text",
          "barRegistrationNumber": "text",
          "advocateType": "PROSECUTOR, PUBLIC DEFENDER",
          "organisationID": "123e4567-e89b-12d3-a456-426614174000",
          "individualId": "text",
          "status": "text",
          "isActive": true,
          "workflow": {
            "action": "text",
            "comment": "text",
            "assignees": [
              "text"
            ],
            "status": "text",
            "documents": [
              {
                "id": "text",
                "documentType": "text",
                "fileStore": "text",
                "documentUid": "text",
                "additionalDetails": {}
              }
            ]
          },
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ],
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "additionalDetails": {}
        }
      ]
    }
  ],
  "pagination": {
    "limit": 1,
    "offSet": 1,
    "totalCount": 1,
    "sortBy": "text",
    "order": {
      "0": "a",
      "1": "s",
      "2": "c"
    }
  }
}

ResponseInfo with advocates matching search criteria

Register a new advocate clerk

post

API to register and verify an advocate clerk

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.

clerkobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/clerk/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
      }
    },
    "clerk": {
      "tenantId": "kl",
      "applicationNumber": "text",
      "stateRegnNumber": "text",
      "individualId": "text",
      "status": "text",
      "isActive": true,
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ],
        "status": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      },
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "additionalDetails": {}
    }
  }'

201

400

201

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "clerks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenantId": "kl",
      "applicationNumber": "text",
      "stateRegnNumber": "text",
      "individualId": "text",
      "status": "text",
      "isActive": true,
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ],
        "status": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      },
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "additionalDetails": {}
    }
  ]
}

ResponseInfo with advocate info updated successfully

Update advocate clerk requests

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.

clerkobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/clerk/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
      }
    },
    "clerk": {
      "tenantId": "kl",
      "applicationNumber": "text",
      "stateRegnNumber": "text",
      "individualId": "text",
      "status": "text",
      "isActive": true,
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ],
        "status": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      },
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "additionalDetails": {}
    }
  }'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "clerks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenantId": "kl",
      "applicationNumber": "text",
      "stateRegnNumber": "text",
      "individualId": "text",
      "status": "text",
      "isActive": true,
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ],
        "status": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      },
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "additionalDetails": {}
    }
  ]
}

ResponseInfo with advocate data updated successfully

search for clerks using the status of their registration

post

Query parameters

statusstringrequired

status of clerks registration being searched

tenantIdstringrequired

Search by tenantId

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/clerk/v1/status/_search?status=text&tenantId=text'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "clerks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenantId": "kl",
      "applicationNumber": "text",
      "stateRegnNumber": "text",
      "individualId": "text",
      "status": "text",
      "isActive": true,
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ],
        "status": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      },
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "additionalDetails": {}
    }
  ]
}

ResponseInfo with advocates matching search criteria

search for clerks using the applicationNumber of their registration

post

Query parameters

applicationNumberstringrequired

applicationNumber of clerks registration being searched

tenantIdstringrequired

Search by tenantId

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/clerk/v1/applicationnumber/_search?applicationNumber=text&tenantId=text'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "clerks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenantId": "kl",
      "applicationNumber": "text",
      "stateRegnNumber": "text",
      "individualId": "text",
      "status": "text",
      "isActive": true,
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ],
        "status": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      },
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "additionalDetails": {}
    }
  ]
}

ResponseInfo with advocates matching search criteria

Search for registered advocate clerk

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.

tenantIdstringoptional

criteriaobject[]optional

the fields specified will be used in a logical AND condition

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/clerk/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": [
      {
        "id": "text",
        "applicationNumber": "text",
        "stateRegnNumber": "text",
        "individualId": "text",
        "responseList": [
          {
            "tenantId": "kl",
            "applicationNumber": "text",
            "stateRegnNumber": "text",
            "individualId": "text",
            "status": "text",
            "isActive": true,
            "workflow": {
              "action": "text",
              "comment": "text",
              "assignees": [
                "text"
              ],
              "status": "text",
              "documents": [
                {
                  "id": "text",
                  "documentType": "text",
                  "fileStore": "text",
                  "documentUid": "text",
                  "additionalDetails": {}
                }
              ]
            },
            "documents": [
              {
                "id": "text",
                "documentType": "text",
                "fileStore": "text",
                "documentUid": "text",
                "additionalDetails": {}
              }
            ],
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text",
              "createdTime": 1,
              "lastModifiedTime": 1
            },
            "additionalDetails": {}
          }
        ]
      }
    ]
  }'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "clerks": [
    {
      "id": "text",
      "applicationNumber": "text",
      "stateRegnNumber": "text",
      "individualId": "text",
      "responseList": [
        {
          "tenantId": "kl",
          "applicationNumber": "text",
          "stateRegnNumber": "text",
          "individualId": "text",
          "status": "text",
          "isActive": true,
          "workflow": {
            "action": "text",
            "comment": "text",
            "assignees": [
              "text"
            ],
            "status": "text",
            "documents": [
              {
                "id": "text",
                "documentType": "text",
                "fileStore": "text",
                "documentUid": "text",
                "additionalDetails": {}
              }
            ]
          },
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ],
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "additionalDetails": {}
        }
      ]
    }
  ],
  "pagination": {
    "limit": 1,
    "offSet": 1,
    "totalCount": 1,
    "sortBy": "text",
    "order": {
      "0": "a",
      "1": "s",
      "2": "c"
    }
  }
}

ResponseInfo with advocate clerks matching search criteria