AML Watchlist
AML Watchlist Upload
Adds entities to a custom AML watchlist. Supports two modes on the same endpoint: (1) adding a single entity (individual or business) with a risk rating and reason, and (2) bulk uploading entities via a CSV file link (csvLink).
POST
/
v2
/
api
/
verifications
/
watchlist
/
upload
AML Watchlist Upload
curl --request POST \
--url https://api.youverify.co/v2/api/verifications/watchlist/upload \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"entityType": "individual",
"entity": "Shekau",
"reasonAdded": "Fraud",
"dateAdded": "2023-11-22",
"riskRating": "High Risk"
}
'import requests
url = "https://api.youverify.co/v2/api/verifications/watchlist/upload"
payload = {
"entityType": "individual",
"entity": "Shekau",
"reasonAdded": "Fraud",
"dateAdded": "2023-11-22",
"riskRating": "High Risk"
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entityType: 'individual',
entity: 'Shekau',
reasonAdded: 'Fraud',
dateAdded: '2023-11-22',
riskRating: 'High Risk'
})
};
fetch('https://api.youverify.co/v2/api/verifications/watchlist/upload', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.youverify.co/v2/api/verifications/watchlist/upload",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'entityType' => 'individual',
'entity' => 'Shekau',
'reasonAdded' => 'Fraud',
'dateAdded' => '2023-11-22',
'riskRating' => 'High Risk'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.youverify.co/v2/api/verifications/watchlist/upload"
payload := strings.NewReader("{\n \"entityType\": \"individual\",\n \"entity\": \"Shekau\",\n \"reasonAdded\": \"Fraud\",\n \"dateAdded\": \"2023-11-22\",\n \"riskRating\": \"High Risk\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.youverify.co/v2/api/verifications/watchlist/upload")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entityType\": \"individual\",\n \"entity\": \"Shekau\",\n \"reasonAdded\": \"Fraud\",\n \"dateAdded\": \"2023-11-22\",\n \"riskRating\": \"High Risk\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/api/verifications/watchlist/upload")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entityType\": \"individual\",\n \"entity\": \"Shekau\",\n \"reasonAdded\": \"Fraud\",\n \"dateAdded\": \"2023-11-22\",\n \"riskRating\": \"High Risk\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "csv link uploaded successfully!",
"data": {},
"links": []
}{
"success": true,
"statusCode": 201,
"message": "Entity added to watchlist successfully!",
"data": {
"entity": "Shekau",
"entityType": "individual",
"reasonAdded": "Fraud",
"riskRating": "High Risk",
"dateAdded": "2023-11-22T00:00:00.000Z",
"businessId": "628b38f03ae28a14f52d4bf7",
"parentId": null,
"createdAt": "2023-11-22T04:46:27.645Z",
"lastModifiedAt": "2023-11-22T04:46:27.645Z",
"id": "655d87a3194cc13dfa887d6a"
},
"links": []
}{
"success": false,
"statusCode": 401,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}{
"success": false,
"statusCode": 402,
"message": "Insufficient fund",
"name": "PaymentRequiredError",
"data": {}
}{
"success": false,
"statusCode": 404,
"message": "You have attempted to get a resource that does not exist.",
"name": "ResourceNotFoundError",
"data": {}
}{
"success": false,
"statusCode": 429,
"message": "Too many requests",
"name": "RateLimitError",
"data": {}
}{
"success": false,
"statusCode": 500,
"message": "Internal Server Error",
"name": "Error",
"data": {}
}Authorizations
Your Youverify API secret key. Never expose client-side.
Headers
API secret token
Body
application/json
Entity type
Available options:
individual, business Entity name (individual or business)
Reason why the entity is being added to the watchlist
Level of risk associated with the entity
Available options:
Low Risk, Medium Risk, High Risk Date the entity was added, format YYYY-MM-DD
Link to AML watchlist CSV to be bulk uploaded (alternative to single-entity fields)
Response
Bulk CSV upload success
⌘I
AML Watchlist Upload
curl --request POST \
--url https://api.youverify.co/v2/api/verifications/watchlist/upload \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"entityType": "individual",
"entity": "Shekau",
"reasonAdded": "Fraud",
"dateAdded": "2023-11-22",
"riskRating": "High Risk"
}
'import requests
url = "https://api.youverify.co/v2/api/verifications/watchlist/upload"
payload = {
"entityType": "individual",
"entity": "Shekau",
"reasonAdded": "Fraud",
"dateAdded": "2023-11-22",
"riskRating": "High Risk"
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entityType: 'individual',
entity: 'Shekau',
reasonAdded: 'Fraud',
dateAdded: '2023-11-22',
riskRating: 'High Risk'
})
};
fetch('https://api.youverify.co/v2/api/verifications/watchlist/upload', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.youverify.co/v2/api/verifications/watchlist/upload",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'entityType' => 'individual',
'entity' => 'Shekau',
'reasonAdded' => 'Fraud',
'dateAdded' => '2023-11-22',
'riskRating' => 'High Risk'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.youverify.co/v2/api/verifications/watchlist/upload"
payload := strings.NewReader("{\n \"entityType\": \"individual\",\n \"entity\": \"Shekau\",\n \"reasonAdded\": \"Fraud\",\n \"dateAdded\": \"2023-11-22\",\n \"riskRating\": \"High Risk\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.youverify.co/v2/api/verifications/watchlist/upload")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entityType\": \"individual\",\n \"entity\": \"Shekau\",\n \"reasonAdded\": \"Fraud\",\n \"dateAdded\": \"2023-11-22\",\n \"riskRating\": \"High Risk\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/api/verifications/watchlist/upload")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entityType\": \"individual\",\n \"entity\": \"Shekau\",\n \"reasonAdded\": \"Fraud\",\n \"dateAdded\": \"2023-11-22\",\n \"riskRating\": \"High Risk\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "csv link uploaded successfully!",
"data": {},
"links": []
}{
"success": true,
"statusCode": 201,
"message": "Entity added to watchlist successfully!",
"data": {
"entity": "Shekau",
"entityType": "individual",
"reasonAdded": "Fraud",
"riskRating": "High Risk",
"dateAdded": "2023-11-22T00:00:00.000Z",
"businessId": "628b38f03ae28a14f52d4bf7",
"parentId": null,
"createdAt": "2023-11-22T04:46:27.645Z",
"lastModifiedAt": "2023-11-22T04:46:27.645Z",
"id": "655d87a3194cc13dfa887d6a"
},
"links": []
}{
"success": false,
"statusCode": 401,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}{
"success": false,
"statusCode": 402,
"message": "Insufficient fund",
"name": "PaymentRequiredError",
"data": {}
}{
"success": false,
"statusCode": 404,
"message": "You have attempted to get a resource that does not exist.",
"name": "ResourceNotFoundError",
"data": {}
}{
"success": false,
"statusCode": 429,
"message": "Too many requests",
"name": "RateLimitError",
"data": {}
}{
"success": false,
"statusCode": 500,
"message": "Internal Server Error",
"name": "Error",
"data": {}
}