Get Bulk Searches
This endpoint facilitates retrieval of detailed information regarding multiple search batches processed by the organization. To obtain batch details, send a GET request to the designated endpoint. Specify the organization's search reference parameter to uniquely identify the batches you wish to access. The response provides an array of batch objects containing metadata such as batch ID and name, alongside a status indicator denoting the success of the retrieval operation.
GET/api/bulk-searches
GET https://api.amlwatcher.com/api/bulk-searches HTTP/1.1Host: api.amlwatcher.comAuthorization: Bearer Token
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 search details and results. |
| data.ai_compliance_decision | An object containing the AI compliance (TruRisk) evaluation summary, including match classification counts, narrative, and recommendation. Note: Present in the response, but will be empty when TruRisk screening is enabled for organization but not performed on the search. |
| data.ai_compliance_status | The status of the AI compliance process (e.g. “COMPLETED”). Note: Present in the response, but will be empty when TruRisk screening is enabled for organization but not performed on the search. |
| data.results.results[].ai_confidence | A numeric confidence score (0-1) for the AI's classification of this match. Note: TruRisk-only field; empty when TruRisk screening is enabled for organization but not performed on the search. |
| data.results.results[].ai_evaluation | A human-readable explanation of why the AI classified this match the way it did. Note: TruRisk-only field; empty when TruRisk screening is enabled for organization but not performed on the search. |
| data.results.results[].ai_status | The AI's classification of the match (e.g. true_positive, false_positive, true_negative, potential_match, uncertain). Note: TruRisk-only field; empty when TruRisk screening is enabled for organization but not performed on the search. |
Sample Response
{
"data": [
{
"batch_id": "Your Batch ID",
"batch_name": "Batch 2"
},
{
"batch_id": "Your Batch ID",
"batch_name": "Batch 1"
}
],
"error": false,
"status": "SUCCESS"
}