Ongoing AML

The "Ongoing AML" feature offers continuous, real-time monitoring and analysis of your AML requests, ensuring your business remains vigilant against financial crimes at all times. By enabling real-time insights, this feature helps you detect and respond to suspicious activities as they happen, significantly reducing the risk of compliance breaches and financial losses.

With Ongoing AML, you can tailor the monitoring timeline to fit your business needs, whether it’s for a few days, weeks, or even months. The feature employs advanced algorithms and data analysis techniques, constantly evaluating transactions for signs of money laundering or other illicit activities. Additionally, Ongoing AML provides live notifications, webhooks, and emails to alert you immediately of any changes or suspicious activities.

Request

"Requests" refer to the various HTTP methods used for interacting with the API, providing details on endpoint URLs, parameters, headers, request bodies, and examples.

Read Ongoing Requests

Description:
The "Read Ongoing Requests" API allows you to retrieve detailed information about all active AML monitoring requests. With this endpoint, you can programmatically access a comprehensive list of all AML requests currently under monitoring, including the entity being monitored, the countries involved, and the status of the request. This API is essential for tracking ongoing AML efforts and ensuring that your business remains compliant with regulatory requirements.

Method Call: GET

API:

https://api.thekyb.com/api/ongoingRequest/read?page=PAGE_NUMBER&limit=LIMIT&search=SEARCH_TERM&country_names[]=COUNTRY_NAME&match_status=MATCH_STATUS&ongoing_monitoring=ONGOING_MONITORING&start_date=START_DATE&end_date=END_DATE

Parameter	Description
search	Type: String Required: Optional Description: The search term used to query specific AML requests. Users can perform searches based on entity names, such as `"john doe"`, or use unique identifiers like `"service_random_id": "kyb-747tsfhfdbhjfd599"`. This flexibility allows for precise filtering of ongoing AML requests based on specific criteria.
page	Type: String Required: Optional Default: 1 Description: Page attribute tells the page number of the retrieved result.The page number can be specified using the "page" query parameter.
limit	Type: String Required: Optional Default: 25 Description: The "limit" key refers to a parameter that allows users to specify the maximum number of results or records they want to receive from a request. This parameter is particularly useful when dealing with large datasets or when users only need a specific number of items from the API response.
country_names	Type: Array Required: Optional Description: An array of country names associated with the AML service. This parameter specifies the countries or regions to which the service is relevant or available. It assists in targeting and managing services based on geographical considerations.
match_status	Type: String Required: Optional Description: The current status of the matching process. `"match_status": "potential match"` indicates that the service request has identified a possible match, but further verification may be required. `"match_status": "no match"` indicates that the service request has been completed, and no match was found.
ongoing_monitoring	Type: String Required: Optional Description: The current status of the ongoing monitoring either `"true"` or `"false"`.
start_date	Type: String Required: Optional Description: Specifies the beginning date for filtering results. The format should be "DD-MM-YYYY". Use this parameter to retrieve records starting from this date onward. If not provided, the API will include all records from the earliest date.
end_date	Type: String Required: Optional Description: Specifies the ending date for filtering results. The format should be "DD-MM-YYYY". Use this parameter to retrieve records up to and including this date. If not provided, the API will include all records up to the present date.

GET /api/ongoingRequest/read HTTP/1.1
Host: api.thekyb.com
Content-Type: application/json
token: YOUR_SECRET_KEY

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
requestHeaders.append("token", "YOUR_SECRET_KEY");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("http://api.thekyb.com/api/ongoingRequest/read", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'http://api.thekyb.com/api/ongoingRequest/read',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'token: YOUR_SECRET_KEY'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests
import json

url = "http://api.thekyb.com/api/ongoingRequest/read"

payload = {}
headers = {
  'Content-Type': 'application/json',
  'token': 'YOUR_SECRET_KEY'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'http://api.thekyb.com/api/ongoingRequest/read',
  headers: { 
    'Content-Type': 'application/json', 
    'token': 'YOUR_SECRET_KEY'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

curl --location 'http://api.thekyb.com/api/ongoingRequest/read' \
--header 'Content-Type: application/json' \
--header 'token: YOUR_SECRET_KEY'

Update Ongoing AML

Description:
The "Update Ongoing AML" API allows you to enable or disable ongoing monitoring for a specific AML request. This API provides a flexible way to manage your AML monitoring processes by giving you control over whether a particular request continues to be monitored in real-time.

Method Call: POST

API:

https://api.thekyb.com/api/ongoingRequest/update

Parameter	Description
service_type	Type: String Required: Yes Description: Specifies the type of ongoing monitoring request. The value is `ongoing_aml` to enable or disable monitoring for an AML company or person.
aml_request_id	Type: String Required: Yes Description: The unique identifier for the AML request you wish to enable or disable ongoing monitoring for. This ID links to a specific AML request that is being monitored or requires monitoring.
duration	Type: Integer Required: Yes Description: Specifies the duration for which ongoing monitoring should be active. This value determines how long the AML request will be monitored. The range of allowed values depends on the `duration_type` parameter: - If `duration_type` is `"day"`, the `duration` value must be between 1 and 7. - If `duration_type` is `"week"`, the `duration` value must be between 1 and 4. - If `duration_type` is `"month"`, the `duration` value must be between 1 and 12.
duration_type	Type: String Required: Yes Description: Defines the unit of time for the duration, such as "day," "week," or "month." This parameter specifies how the duration should be interpreted (e.g., "1 day" or "1 month").
ongoing_enable	Type: Boolean Required: Yes Description: A boolean flag to enable or disable ongoing monitoring for the specified AML request. Set to true to enable monitoring or false to disable it. This parameter directly controls whether the request will be actively monitored in real-time.

POST /api/ongoingRequest/update HTTP/1.1
Host: api.thekyb.com
Content-Type: application/json
token: YOUR_SECRET_KEY

{ 
    "service_type": "ongoing_aml",
    "aml_request_id": "YOUR_AML_REQUEST_ID", 
    "duration": 1, 
    "duration_type": "day", 
    "ongoing_enable": true
}

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("token", "YOUR_SECRET_KEY");

var raw = JSON.stringify({
  "service_type": "ongoing_aml",
  "aml_request_id": "YOUR_AML_REQUEST_ID",
  "duration": 1,
  "duration_type": "day",
  "ongoing_enable": true
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://api.thekyb.com/api/ongoingRequest/update", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.thekyb.com/api/ongoingRequest/update',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{ 
            "service_type": "ongoing_aml",
            "aml_request_id": "YOUR_AML_REQUEST_ID", 
            "duration": 1, 
            "duration_type": "day", 
            "ongoing_enable": true
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'token: YOUR_SECRET_KEY'

  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests
import json

url = "https://api.thekyb.com/api/ongoingRequest/update"

payload = json.dumps({
  "service_type": "ongoing_aml",
  "aml_request_id": "YOUR_AML_REQUEST_ID",
  "duration": "1",
  "duration_type": "day",
  "ongoing_enable": True
})
headers = {
  'Content-Type': 'application/json',
  'token': 'YOUR_SECRET_KEY'

}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

const axios = require('axios');
let data = JSON.stringify({
  "service_type": "ongoing_aml",
  "aml_request_id": "YOUR_AML_REQUEST_ID",
  "duration": 1,
  "duration_type": "day",
  "ongoing_enable": true
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.thekyb.com/api/ongoingRequest/update',
  headers: { 
    'Content-Type': 'application/json', 
    'token': 'YOUR_SECRET_KEY'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

curl --location 'https://api.thekyb.com/api/ongoingRequest/update' \
--header 'Content-Type: application/json' \
--header 'token: YOUR_SECRET_KEY' \
--data '{ 
            "service_type": "ongoing_aml",
            "aml_request_id": "YOUR_AML_REQUEST_ID", 
            "duration": 1, 
            "duration_type": "day", 
            "ongoing_enable": true
}'

Response

The Ongoing AML API provides two types of responses when an ongoing monitoring request is made: an HTTP response and a callback response. Both responses are delivered in JSON format with an application/json header. The response includes a Key Signature in the header, which is used to verify the authenticity of the response source.

Read Ongoing Requests

Description:
The "Read Ongoing Requests" response serves as an essential tool for users to monitor and manage their ongoing AML activities. By delivering detailed information about each active monitoring request, including the entity being monitored, involved countries, and current status, users can effectively track their AML efforts. This comprehensive overview enables businesses to stay informed about potential risks, ensuring they remain compliant with regulatory requirements and can make timely decisions to mitigate financial crime.

Method Call: GET

API:

https://api.thekyb.com/api/ongoingRequest/read?page=PAGE_NUMBER&limit=LIMIT&search=SEARCH_TERM&country_names[]=COUNTRY_NAME&match_status=MATCH_STATUS&ongoing_monitoring=ONGOING_MONITORING&start_date=START_DATE&end_date=END_DATE

Response:

{
  "error": false,
  "message": "Ongoing requests fetched successfully",
  "data": {
     "ongoing_requests": [
            {
                "_id": "66b5c19f56de2d9dcf01db07",
                "aml_request_id": "66b5c18fmnsdfbjfsd706748b",
                "service_random_id": "kyb-747tsfdbksfd599",
                "search": "john doe",
                "country_names": [
                    "afghanistan",
                    "albania",
                    "algeria",
                    ...
                ],
                "duration": "",
                "duration_type": "",
                "service_type": [
                    "ongoing_aml"
                ],
                "ongoing_monitoring": false,
                "match_status": "no match",
                "total_ongoing_request": 1,
                "last_updated_at": "2024-08-09T07:14:38.302000Z",
                "created_at": "2024-08-09T07:13:35.806000Z"
            },
        ]
  }
}

Response Parameters:

Parameter	Description
error	Indicates whether an error occurred during the API request. `false` indicates that the request was successful without errors.
message	A descriptive message indicating the status or outcome of the request. In this case, it confirms that ongoing requests were fetched successfully.
data.ongoing_requests	An array containing ongoing request objects. Each object holds detailed information about a specific ongoing request.
data.ongoing_requests._id	A unique identifier for the ongoing request.
data.ongoing_requests.aml_request_id	A unique identifier for the AML request associated with this ongoing request.
data.ongoing_requests.service_random_id	A unique identifier for the service request, represented as a random string.
data.ongoing_requests.search	The search term used for the ongoing request, in this case, "john doe".
data.ongoing_requests.country_names	An array of country names associated with the ongoing request.
data.ongoing_requests.service_type	An array listing the service_type associated with the ongoing request, such as "ongoing_aml".
data.ongoing_requests.ongoing_monitoring	A boolean indicating whether ongoing monitoring is enabled/disabled for this request. The value `true` indicates it is enabled, while the value `false` indicates it is disabled.
data.ongoing_requests.match_status	The match status of the ongoing AML request. It can be either `no match"` or `potential match`.
data.ongoing_requests.total_ongoing_request	The total number of ongoing requests on an AML request.
data.ongoing_requests.last_updated_at	The timestamp of the last update made to this ongoing request.
data.ongoing_requests.created_at	The timestamp of when the ongoing request was created.

Update Ongoing AML

Description:
The "Update Ongoing AML" response confirms the success or failure of your request to enable or disable ongoing monitoring for a specific AML request.

Method Call: POST

API:

https://api.thekyb.com/api/ongoingRequest/update

Response:

{
    "error": false,
    "message": "Ongoing AML enabled successfully",
    "data": {}
}

Response Parameters:

Parameter	Description
error	The "error" parameter can have a value of either "true" or "false." In the current scenario, since there were no errors during the request processing, the value of "error" is "false." However, in situations where errors occur, such as missing required parameters or criteria not being met, the value of the "error" parameter will change to "true."
message	The "message" field in API response formats provides a descriptive text or notification intended to convey additional information or instructions to the API consumer. It is commonly used to communicate relevant details about the response, such as success messages, error messages, or any other informative content that aids in understanding the outcome of the API request. The "message" field helps provide context and guidance to the API consumer regarding the status or result of the API operation.

Parameter

Description

error

The "error" parameter can have a value of either "true" or "false." In the current scenario, since there were no errors during the request processing, the value of "error" is "false." However, in situations where errors occur, such as missing required parameters or criteria not being met, the value of the "error" parameter will change to "true."

message

The "message" field in API response formats provides a descriptive text or notification intended to convey additional information or instructions to the API consumer. It is commonly used to communicate relevant details about the response, such as success messages, error messages, or any other informative content that aids in understanding the outcome of the API request. The "message" field helps provide context and guidance to the API consumer regarding the status or result of the API operation.

Request​

Read Ongoing Requests​

Update Ongoing AML​

Response​

Read Ongoing Requests​

Update Ongoing AML​

Request

Read Ongoing Requests

Update Ongoing AML

Response

Read Ongoing Requests

Update Ongoing AML