Get Bulk Search
This API endpoint facilitates the retrieval of detailed information regarding specific searches within the organization. To access details of a particular search, issue a GET request to the designated endpoint, providing the unique search reference parameter. This parameter ensures precise identification of the desired search, enabling seamless retrieval of relevant data.
GET/api/bulk-searches/:batch_id
GET https://api.amlwatcher.com/api/bulk-searches/:batch_id HTTP/1.1Host: api.amlwatcher.comAuthorization: Bearer Token
Request
Parameters | Required | Type | Description |
---|---|---|---|
batch_id | Yes | String | A unique batch id representing a corresponding batch. |
Response
Parameters | Description |
---|---|
error | Whenever there is an error in your request, this param will have details of that error; otherwise it’ll remain empty. |
status | The status field is set to either “SUCCESS” or “FAIL”, indicating that the API request resulted in a successful or failure/error condition respectively. |
data | An object containing the actual response elements. |
Sample Response
{
"data": {
"batch_id": "f0b8097d28c0c52b53afe1ea",
"search_references": [
"61ad945ebdecad0871c7835a",
"47f81b4181b69e059de95a68"
]
},
"error": false,
"status": "SUCCESS"
}