Participants & Sanctions
Create and execute sanctions/PEP/AML screening check
Initiates one granular compliance screening check for the participant.
POST
/
api
/
v1
/
participants
/
{id}
/
sanctions-check
Create and execute sanctions/PEP/AML screening check
curl --request POST \
--url https://uat.gateway.verify-group.io/api/v1/participants/{id}/sanctions-check \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"participantId": "<string>",
"organizationId": "<string>",
"checkType": {},
"checkTypes": [
{}
],
"searchName": "<string>",
"searchCountries": [
{}
],
"searchDob": "<string>",
"dataSources": [
{}
],
"enableMonitoring": true
}
'import requests
url = "https://uat.gateway.verify-group.io/api/v1/participants/{id}/sanctions-check"
payload = {
"participantId": "<string>",
"organizationId": "<string>",
"checkType": {},
"checkTypes": [{}],
"searchName": "<string>",
"searchCountries": [{}],
"searchDob": "<string>",
"dataSources": [{}],
"enableMonitoring": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
participantId: '<string>',
organizationId: '<string>',
checkType: {},
checkTypes: [{}],
searchName: '<string>',
searchCountries: [{}],
searchDob: '<string>',
dataSources: [{}],
enableMonitoring: true
})
};
fetch('https://uat.gateway.verify-group.io/api/v1/participants/{id}/sanctions-check', 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://uat.gateway.verify-group.io/api/v1/participants/{id}/sanctions-check",
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([
'participantId' => '<string>',
'organizationId' => '<string>',
'checkType' => [
],
'checkTypes' => [
[
]
],
'searchName' => '<string>',
'searchCountries' => [
[
]
],
'searchDob' => '<string>',
'dataSources' => [
[
]
],
'enableMonitoring' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://uat.gateway.verify-group.io/api/v1/participants/{id}/sanctions-check"
payload := strings.NewReader("{\n \"participantId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"checkType\": {},\n \"checkTypes\": [\n {}\n ],\n \"searchName\": \"<string>\",\n \"searchCountries\": [\n {}\n ],\n \"searchDob\": \"<string>\",\n \"dataSources\": [\n {}\n ],\n \"enableMonitoring\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://uat.gateway.verify-group.io/api/v1/participants/{id}/sanctions-check")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"participantId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"checkType\": {},\n \"checkTypes\": [\n {}\n ],\n \"searchName\": \"<string>\",\n \"searchCountries\": [\n {}\n ],\n \"searchDob\": \"<string>\",\n \"dataSources\": [\n {}\n ],\n \"enableMonitoring\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://uat.gateway.verify-group.io/api/v1/participants/{id}/sanctions-check")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"participantId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"checkType\": {},\n \"checkTypes\": [\n {}\n ],\n \"searchName\": \"<string>\",\n \"searchCountries\": [\n {}\n ],\n \"searchDob\": \"<string>\",\n \"dataSources\": [\n {}\n ],\n \"enableMonitoring\": true\n}"
response = http.request(request)
puts response.read_bodyParticipant ID
Participant ID to screen
Organization ID (auto-resolved from authenticated user when omitted)
Granular screening type to perform. Defaults to watchlist when omitted.
Deprecated legacy grouped check types. If provided, only the first type is used.
Custom search name (defaults to participant full name)
Countries to search in (ISO 3166-1 alpha-2 codes)
Date of birth for enhanced matching
the watchlist provider source short_name values to include in the search. Required for source-based watchlist screening.
Enable continuous monitoring
Previous
Get all sanctions checks for a participantRetrieves all sanctions screening checks performed on this participant.
Next
⌘I
Create and execute sanctions/PEP/AML screening check
curl --request POST \
--url https://uat.gateway.verify-group.io/api/v1/participants/{id}/sanctions-check \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"participantId": "<string>",
"organizationId": "<string>",
"checkType": {},
"checkTypes": [
{}
],
"searchName": "<string>",
"searchCountries": [
{}
],
"searchDob": "<string>",
"dataSources": [
{}
],
"enableMonitoring": true
}
'import requests
url = "https://uat.gateway.verify-group.io/api/v1/participants/{id}/sanctions-check"
payload = {
"participantId": "<string>",
"organizationId": "<string>",
"checkType": {},
"checkTypes": [{}],
"searchName": "<string>",
"searchCountries": [{}],
"searchDob": "<string>",
"dataSources": [{}],
"enableMonitoring": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
participantId: '<string>',
organizationId: '<string>',
checkType: {},
checkTypes: [{}],
searchName: '<string>',
searchCountries: [{}],
searchDob: '<string>',
dataSources: [{}],
enableMonitoring: true
})
};
fetch('https://uat.gateway.verify-group.io/api/v1/participants/{id}/sanctions-check', 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://uat.gateway.verify-group.io/api/v1/participants/{id}/sanctions-check",
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([
'participantId' => '<string>',
'organizationId' => '<string>',
'checkType' => [
],
'checkTypes' => [
[
]
],
'searchName' => '<string>',
'searchCountries' => [
[
]
],
'searchDob' => '<string>',
'dataSources' => [
[
]
],
'enableMonitoring' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://uat.gateway.verify-group.io/api/v1/participants/{id}/sanctions-check"
payload := strings.NewReader("{\n \"participantId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"checkType\": {},\n \"checkTypes\": [\n {}\n ],\n \"searchName\": \"<string>\",\n \"searchCountries\": [\n {}\n ],\n \"searchDob\": \"<string>\",\n \"dataSources\": [\n {}\n ],\n \"enableMonitoring\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://uat.gateway.verify-group.io/api/v1/participants/{id}/sanctions-check")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"participantId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"checkType\": {},\n \"checkTypes\": [\n {}\n ],\n \"searchName\": \"<string>\",\n \"searchCountries\": [\n {}\n ],\n \"searchDob\": \"<string>\",\n \"dataSources\": [\n {}\n ],\n \"enableMonitoring\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://uat.gateway.verify-group.io/api/v1/participants/{id}/sanctions-check")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"participantId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"checkType\": {},\n \"checkTypes\": [\n {}\n ],\n \"searchName\": \"<string>\",\n \"searchCountries\": [\n {}\n ],\n \"searchDob\": \"<string>\",\n \"dataSources\": [\n {}\n ],\n \"enableMonitoring\": true\n}"
response = http.request(request)
puts response.read_body