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.

POST/api/searches

POST https://api.amlwatcher.com/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",
    "created_at": "DD-MM-YYYY"
}

Request

Parameters	Required	Type	Description
created_at	No	String	Allows the user to retrieve date specific search information. Format: DD-MM-YYYY
page	No	String / Integer	It indicates the current page number. Default: 1
records_per_page	No	String / Integer	It allow the users to specify the number of search records they want to receive on each page. Default: 15

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 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": "ID of the search"
          },
          "adverse_media_monitoring": false,
          "adverse_status": "N/A",
          "assignees": [
              {
                  "assigned_at": {
                      "$date": 1698225209114
                  },
                  "assigned_to": "Assigned user ID",
                  "assignee_id": "Assignee ID",
                  "email": "user@amlwatcher.com",
                  "name": "Admin"
              }
          ],
          "callback_status": "N/A",
          "callback_url": "N/A",
          "client_reference": "",
          "comments": [],
          "created_at": {
              "$date": 1698225209114
          },
          "input_language": "en",
          "is_adverse_required": "NO",
          "is_monitored": false,
          "is_monitored_at": {
            "$date": 1787669415731
          },
          "is_read": true,
          "is_updated": false,
          "match_status": "Potential Match",
          "normalized_name": "keith campbell",
          "organization_id": {
              "$oid": "Your Organization ID"
          },
          "platform": "BACKOFFICE",
          "read_by": [
            "User IDs, Who Read This Search"
          ],
          "reference": {
            "custom_list_search": false
          },
          "risk_decision": "Passed",
          "risk_level": "Low",
          "risk_score": "Low",
          "search_filters": {
            "adverse_media_monitoring": false,
            "alias_search": true,
            "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"
            ],
            "client_reference": "",
            "countries": [
              "UK"
            ],
            "entity_type": [
              "Person"
            ],
            "exact_search": true,
            "group_data": true,
            "match_score": 100,
            "name": "Keith Campbell",
            "ongoing_monitoring": true,
            "page": 1,
            "per_page": 160,
            "rca_search": false,
            "retrieve_results": false,
            "risk_score_engine_id": "Your Organization Risk Engine ID",
            "risk_score_engine_title": "Risk Engine Title",
            "search_profile": "",
            "unique_identifier": ""
          },
          "search_reference": "Reference ID of search",
          "searched_categories": {
            "PEP": 1,
            "PEP Level 1": 1,
            "PEP Level 2": 2,
            "PEP Level 4": 1,
            "Fitness and Probity": 1
          },
          "searched_countries": {
            "United Kingdom": 6
          },
          "total_adverse_media": 0,
          "total_results": 6,
          "updated_at": {
            "$date": 1698225209114
          },
          "user_id": {
            "$oid": "User ID"
          }
      }
    ]
  },
  "error": false,
  "status": "SUCCESS"
}