AML lookup
curl --request POST \
--url https://api.onswitch.xyz/compliance/aml/lookup \
--header 'Content-Type: application/json' \
--header 'x-service-key: <api-key>' \
--data '
{
"type": "INDIVIDUAL",
"name": "Jane Doe",
"country": "NG",
"date_of_birth": "1990-01-15"
}
'import requests
url = "https://api.onswitch.xyz/compliance/aml/lookup"
payload = {
"type": "INDIVIDUAL",
"name": "Jane Doe",
"country": "NG",
"date_of_birth": "1990-01-15"
}
headers = {
"x-service-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-service-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'INDIVIDUAL',
name: 'Jane Doe',
country: 'NG',
date_of_birth: '1990-01-15'
})
};
fetch('https://api.onswitch.xyz/compliance/aml/lookup', 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.onswitch.xyz/compliance/aml/lookup",
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',
'name' => 'Jane Doe',
'country' => 'NG',
'date_of_birth' => '1990-01-15'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-service-key: <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.onswitch.xyz/compliance/aml/lookup"
payload := strings.NewReader("{\n \"type\": \"INDIVIDUAL\",\n \"name\": \"Jane Doe\",\n \"country\": \"NG\",\n \"date_of_birth\": \"1990-01-15\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-service-key", "<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.onswitch.xyz/compliance/aml/lookup")
.header("x-service-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"INDIVIDUAL\",\n \"name\": \"Jane Doe\",\n \"country\": \"NG\",\n \"date_of_birth\": \"1990-01-15\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onswitch.xyz/compliance/aml/lookup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-service-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"INDIVIDUAL\",\n \"name\": \"Jane Doe\",\n \"country\": \"NG\",\n \"date_of_birth\": \"1990-01-15\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "AML lookup successful",
"timestamp": "2026-05-13T21:44:33.474Z",
"data": {
"status": "REJECTED",
"reference": "18a51cca-ed07-4a74-b1b7-03cceab33e23",
"details": {
"subject": {
"type": "INDIVIDUAL",
"country": "NG",
"name": "tinubu bola",
"is_sandbox": false
},
"matches": [
{
"certainty": 92,
"name": "Bola Ahmed Tinubu",
"flags": [
"PEP"
],
"last_updated": "2024-10-11T12:50:30"
},
{
"certainty": 83,
"name": "Bola Ahmed Tinubu Gcfr",
"flags": [
"PEP"
],
"last_updated": "2026-04-26T13:01:02"
}
]
}
}
}{
"success": false,
"message": "amount must be greater than 0 for the selected corridor",
"timestamp": "2026-04-18T14:22:08.631Z",
"data": null
}AML lookup
Screen an individual, business or crypto wallet against global compliance data.
POST
/
compliance
/
aml
/
lookup
AML lookup
curl --request POST \
--url https://api.onswitch.xyz/compliance/aml/lookup \
--header 'Content-Type: application/json' \
--header 'x-service-key: <api-key>' \
--data '
{
"type": "INDIVIDUAL",
"name": "Jane Doe",
"country": "NG",
"date_of_birth": "1990-01-15"
}
'import requests
url = "https://api.onswitch.xyz/compliance/aml/lookup"
payload = {
"type": "INDIVIDUAL",
"name": "Jane Doe",
"country": "NG",
"date_of_birth": "1990-01-15"
}
headers = {
"x-service-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-service-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'INDIVIDUAL',
name: 'Jane Doe',
country: 'NG',
date_of_birth: '1990-01-15'
})
};
fetch('https://api.onswitch.xyz/compliance/aml/lookup', 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.onswitch.xyz/compliance/aml/lookup",
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',
'name' => 'Jane Doe',
'country' => 'NG',
'date_of_birth' => '1990-01-15'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-service-key: <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.onswitch.xyz/compliance/aml/lookup"
payload := strings.NewReader("{\n \"type\": \"INDIVIDUAL\",\n \"name\": \"Jane Doe\",\n \"country\": \"NG\",\n \"date_of_birth\": \"1990-01-15\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-service-key", "<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.onswitch.xyz/compliance/aml/lookup")
.header("x-service-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"INDIVIDUAL\",\n \"name\": \"Jane Doe\",\n \"country\": \"NG\",\n \"date_of_birth\": \"1990-01-15\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onswitch.xyz/compliance/aml/lookup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-service-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"INDIVIDUAL\",\n \"name\": \"Jane Doe\",\n \"country\": \"NG\",\n \"date_of_birth\": \"1990-01-15\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "AML lookup successful",
"timestamp": "2026-05-13T21:44:33.474Z",
"data": {
"status": "REJECTED",
"reference": "18a51cca-ed07-4a74-b1b7-03cceab33e23",
"details": {
"subject": {
"type": "INDIVIDUAL",
"country": "NG",
"name": "tinubu bola",
"is_sandbox": false
},
"matches": [
{
"certainty": 92,
"name": "Bola Ahmed Tinubu",
"flags": [
"PEP"
],
"last_updated": "2024-10-11T12:50:30"
},
{
"certainty": 83,
"name": "Bola Ahmed Tinubu Gcfr",
"flags": [
"PEP"
],
"last_updated": "2026-04-26T13:01:02"
}
]
}
}
}{
"success": false,
"message": "amount must be greater than 0 for the selected corridor",
"timestamp": "2026-04-18T14:22:08.631Z",
"data": null
}Authorizations
Service key for API authentication
Body
application/json
- Individual
- Business
- Crypto wallet
Available options:
INDIVIDUAL Legal name of the individual to screen.
Available options:
BJ, CD, CI, CM, ET, GA, GH, GM, GN, KE, LR, ML, MW, NG, RW, SL, SN, TZ, UG, ZA, ZM Date of birth in YYYY-MM-DD.
Response
AML lookup completed
Hide child attributes
Hide child attributes
Available options:
PENDING, REJECTED, APPROVED, REVIEW Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Available options:
INDIVIDUAL, BUSINESS, CRYPTO_WALLET ⌘I