Skip to main content

Get all Searches

This endpoint allows you to retrieve a list of all searches that belong to the specified organization. It provides you with a comprehensive overview of all searches and associated metadata. It is especially useful for managing and monitoring searches, ensuring that you have access to all relevant information.

Endpoint: https://api.amlwatcher.com/api/searches

Method: POST

Sample Request
POST /api/searches HTTP/1.1
Host: api.amlwatcher.com
Authorization: Bearer Token
Content-Type: application/json
Content-Length: 48

{
"page": "1",
"records_per_page": "6"
}

Request

ParametersRequiredTypeDescription
created_atNoStringAllows the user to retrieve date specific search information.
Format: DD-MM-YYYY
pageNoString / IntegerIt indicates the current page number.
Default: 1
records_per_pageNoString / IntegerIt allow the users to specify the number of search records they want to receive on each page.
Default: 15

Response

ParametersDescription
errorWhenever there is an error in your request, this param will have details of that error; otherwise it’ll remain empty.
statusThe status field is set to either “SUCCESS” or “FAIL”, indicating that the API request resulted in a successful or failure/error condition respectively.
dataAn array containing the actual response elements.
Sample Response
{
"data": {
"pagination": {
"current_page": 1,
"records_per_page": 15,
"total_pages": 5,
"total_records": 62
},
"searches": [
{
"_id": {
"$oid": "6538c019b2827e7f3487"
},
"assignees": [
{
"assigned_at": {
"$date": 1698225209114
},
"assigned_to": "6512d715dadd17911a2956",
"assignee_id": "6512d715dadd1b871a2956",
"email": "[email protected]",
"name": "Admin"
}
],
"client_reference": "",
"comments": [],
"created_at": {
"$date": 1698225209114
},
"is_monitored": false,
"is_updated": false,
"match_status": "Potential Match",
"organization_id": {
"$oid": "6512d7134bb9ce3c1394"
},
"platform": "BACKOFFICE",
"search_filters": {
"birth_incorporation_date": "",
"categories": [
"Fitness and Probity",
"Warnings and Regulatory Enforcement",
"Sanctions",
"PEP Level 1",
"PEP Level 2",
"PEP Level 3",
"PEP Level 4",
"PEP"
],
"match_score": 100,
"name": "Keith Campbell",
"unique_identifier": ""
},
"search_reference": "8d13c6a1a80d0a77d6b5a0",
"total_results": 6,
"updated_at": {
"$date": 1698225209114
},
"user_id": {
"$oid": "6512d715dadd111a2956"
}
}
]
},
"error": false,
"status": "SUCCESS"
}