AML Screening
Search using Identity
Enables searching for politically exposed persons (PEP) and sanctioned entities using identity numbers, phone numbers, or company registration numbers. Supports an optional ‘advancedSearch’ object (firstName, lastName, position, keyword, gender, country, education) to streamline the search, as described on the Advanced Filters sub-page for this endpoint.
POST
/
v2
/
api
/
verifications
/
advanced
/
identity
/
aml-checks
Search using Identity
curl --request POST \
--url https://api.youverify.co/v2/api/verifications/advanced/identity/aml-checks \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"type": "individual",
"query": "+2347037730852",
"isSubjectConsent": "true"
}
'import requests
url = "https://api.youverify.co/v2/api/verifications/advanced/identity/aml-checks"
payload = {
"type": "individual",
"query": "+2347037730852",
"isSubjectConsent": "true"
}
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({type: 'individual', query: '+2347037730852', isSubjectConsent: 'true'})
};
fetch('https://api.youverify.co/v2/api/verifications/advanced/identity/aml-checks', 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/advanced/identity/aml-checks",
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([
'type' => 'individual',
'query' => '+2347037730852',
'isSubjectConsent' => 'true'
]),
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/advanced/identity/aml-checks"
payload := strings.NewReader("{\n \"type\": \"individual\",\n \"query\": \"+2347037730852\",\n \"isSubjectConsent\": \"true\"\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/advanced/identity/aml-checks")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"individual\",\n \"query\": \"+2347037730852\",\n \"isSubjectConsent\": \"true\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/api/verifications/advanced/identity/aml-checks")
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 \"type\": \"individual\",\n \"query\": \"+2347037730852\",\n \"isSubjectConsent\": \"true\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "success",
"data": {
"status": "review_required",
"parentId": null,
"isSubjectConsent": true,
"type": "individual",
"sanctions": [],
"pep": [
{
"title": [
"MUHAMMED GUDAJI"
],
"entityType": "Person",
"datasets": [
"wd_peps",
"wikidata",
"everypolitician"
],
"gender": [
"male"
],
"position": [
"member of the House of Representatives of Nigeria",
"member of the House of Representatives of Nigeria (2019-)",
"House of Representatives (member, 2015-)"
],
"topics": [
"role.pep"
],
"birthDate": [
"1972-01-01T00:00:00.000Z"
],
"alias": [
"Muhammed Gudaji",
"Muhammad Aliyu Gudaji",
"MUHAMMED KAZAURE GUDAJI",
"Muhammed Kazaure Gudaji",
"Muhammed Gudaji Kazaure"
],
"keywords": [
"National government"
],
"country": [
"ng"
],
"nationality": [
"ng"
],
"notes": [
"Nigerian politician"
],
"name": [
"Muhammed Gudaji",
"MUHAMMED GUDAJI"
],
"phone": [
"+2347037730852"
],
"positionOccupancies": [
{
"post": [
{
"country": [
"ng"
],
"name": [
"member of the House of Representatives of Nigeria"
]
}
],
"status": [
"ended"
],
"startDate": [
"2019-06-11T00:00:00.000Z"
],
"endDate": [
"2023-06-11T00:00:00.000Z"
]
},
{
"post": [
{
"country": [
"ng"
],
"name": [
"member of the House of Representatives of Nigeria"
]
}
],
"status": [
"ended"
],
"endDate": [
"2019-06-09T00:00:00.000Z"
],
"startDate": [
"2015-06-09T00:00:00.000Z"
]
}
]
}
],
"crime": [],
"debarment": [],
"financial_services": [],
"government": [],
"role": [],
"religion": [],
"military": [],
"frozen_asset": [],
"personOfInterest": [],
"totalEntity": 1,
"categoryCount": {
"sanctions": 0,
"pep": 1,
"crime": 0,
"debarment": 0,
"financial_services": 0,
"government": 0,
"role": 0,
"religion": 0,
"military": 0,
"frozen_asset": 0,
"personOfInterest": 0
},
"queriedWith": "Identity Number",
"query": "+2347037730852",
"businessId": "6222a5ed3e7a41c29c031ecc",
"requestedAt": "2023-09-21T07:18:47.482Z",
"requestedById": "6222a5ed3e7a41c29c031ece",
"createdAt": "2023-09-21T07:18:47.572Z",
"lastModifiedAt": "2023-09-21T07:18:47.572Z",
"id": "650bee57b5646f3c2c54a979",
"requestedBy": {
"firstName": "API",
"lastName": "User",
"middleName": "",
"id": "6222a5ed3e7a41c29c031ece"
}
},
"links": []
}{
"success": false,
"statusCode": 401,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}{
"success": false,
"statusCode": 402,
"message": "Insufficient fund",
"name": "PaymentRequiredError",
"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
Identity identifier to search with (e.g. phone number, ID number, registration number)
Confirm subject consent given. Must be true
Entity classification
Available options:
all, individual, business Contains features that can streamline your search
Show child attributes
Show child attributes
Response
Success
⌘I
Search using Identity
curl --request POST \
--url https://api.youverify.co/v2/api/verifications/advanced/identity/aml-checks \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"type": "individual",
"query": "+2347037730852",
"isSubjectConsent": "true"
}
'import requests
url = "https://api.youverify.co/v2/api/verifications/advanced/identity/aml-checks"
payload = {
"type": "individual",
"query": "+2347037730852",
"isSubjectConsent": "true"
}
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({type: 'individual', query: '+2347037730852', isSubjectConsent: 'true'})
};
fetch('https://api.youverify.co/v2/api/verifications/advanced/identity/aml-checks', 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/advanced/identity/aml-checks",
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([
'type' => 'individual',
'query' => '+2347037730852',
'isSubjectConsent' => 'true'
]),
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/advanced/identity/aml-checks"
payload := strings.NewReader("{\n \"type\": \"individual\",\n \"query\": \"+2347037730852\",\n \"isSubjectConsent\": \"true\"\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/advanced/identity/aml-checks")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"individual\",\n \"query\": \"+2347037730852\",\n \"isSubjectConsent\": \"true\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.youverify.co/v2/api/verifications/advanced/identity/aml-checks")
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 \"type\": \"individual\",\n \"query\": \"+2347037730852\",\n \"isSubjectConsent\": \"true\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "success",
"data": {
"status": "review_required",
"parentId": null,
"isSubjectConsent": true,
"type": "individual",
"sanctions": [],
"pep": [
{
"title": [
"MUHAMMED GUDAJI"
],
"entityType": "Person",
"datasets": [
"wd_peps",
"wikidata",
"everypolitician"
],
"gender": [
"male"
],
"position": [
"member of the House of Representatives of Nigeria",
"member of the House of Representatives of Nigeria (2019-)",
"House of Representatives (member, 2015-)"
],
"topics": [
"role.pep"
],
"birthDate": [
"1972-01-01T00:00:00.000Z"
],
"alias": [
"Muhammed Gudaji",
"Muhammad Aliyu Gudaji",
"MUHAMMED KAZAURE GUDAJI",
"Muhammed Kazaure Gudaji",
"Muhammed Gudaji Kazaure"
],
"keywords": [
"National government"
],
"country": [
"ng"
],
"nationality": [
"ng"
],
"notes": [
"Nigerian politician"
],
"name": [
"Muhammed Gudaji",
"MUHAMMED GUDAJI"
],
"phone": [
"+2347037730852"
],
"positionOccupancies": [
{
"post": [
{
"country": [
"ng"
],
"name": [
"member of the House of Representatives of Nigeria"
]
}
],
"status": [
"ended"
],
"startDate": [
"2019-06-11T00:00:00.000Z"
],
"endDate": [
"2023-06-11T00:00:00.000Z"
]
},
{
"post": [
{
"country": [
"ng"
],
"name": [
"member of the House of Representatives of Nigeria"
]
}
],
"status": [
"ended"
],
"endDate": [
"2019-06-09T00:00:00.000Z"
],
"startDate": [
"2015-06-09T00:00:00.000Z"
]
}
]
}
],
"crime": [],
"debarment": [],
"financial_services": [],
"government": [],
"role": [],
"religion": [],
"military": [],
"frozen_asset": [],
"personOfInterest": [],
"totalEntity": 1,
"categoryCount": {
"sanctions": 0,
"pep": 1,
"crime": 0,
"debarment": 0,
"financial_services": 0,
"government": 0,
"role": 0,
"religion": 0,
"military": 0,
"frozen_asset": 0,
"personOfInterest": 0
},
"queriedWith": "Identity Number",
"query": "+2347037730852",
"businessId": "6222a5ed3e7a41c29c031ecc",
"requestedAt": "2023-09-21T07:18:47.482Z",
"requestedById": "6222a5ed3e7a41c29c031ece",
"createdAt": "2023-09-21T07:18:47.572Z",
"lastModifiedAt": "2023-09-21T07:18:47.572Z",
"id": "650bee57b5646f3c2c54a979",
"requestedBy": {
"firstName": "API",
"lastName": "User",
"middleName": "",
"id": "6222a5ed3e7a41c29c031ece"
}
},
"links": []
}{
"success": false,
"statusCode": 401,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}{
"success": false,
"statusCode": 402,
"message": "Insufficient fund",
"name": "PaymentRequiredError",
"data": {}
}{
"success": false,
"statusCode": 429,
"message": "Too many requests",
"name": "RateLimitError",
"data": {}
}{
"success": false,
"statusCode": 500,
"message": "Internal Server Error",
"name": "Error",
"data": {}
}