PEP & Sanctions
curl --request POST \
--url https://api.deepidv.com/v1/screening/pep-sanctionsimport requests
url = "https://api.deepidv.com/v1/screening/pep-sanctions"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.deepidv.com/v1/screening/pep-sanctions', 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.deepidv.com/v1/screening/pep-sanctions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.deepidv.com/v1/screening/pep-sanctions"
req, _ := http.NewRequest("POST", url, nil)
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.deepidv.com/v1/screening/pep-sanctions")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.deepidv.com/v1/screening/pep-sanctions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"totalMatches": 1,
"peps": [
{
"name": "John Doe",
"country": "US",
"dateOfBirth": "1980-01-15",
"confidence": 0.92,
"datasets": ["us_ofac_sdn"]
}
],
"sanctions": [],
"both": [],
"searchedSources": ["local", "opensanctions"]
}
Silent Screening
PEP & Sanctions
Screen individuals against global PEP and sanctions lists
POST
/
v1
/
screening
/
pep-sanctions
PEP & Sanctions
curl --request POST \
--url https://api.deepidv.com/v1/screening/pep-sanctionsimport requests
url = "https://api.deepidv.com/v1/screening/pep-sanctions"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.deepidv.com/v1/screening/pep-sanctions', 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.deepidv.com/v1/screening/pep-sanctions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.deepidv.com/v1/screening/pep-sanctions"
req, _ := http.NewRequest("POST", url, nil)
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.deepidv.com/v1/screening/pep-sanctions")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.deepidv.com/v1/screening/pep-sanctions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"totalMatches": 1,
"peps": [
{
"name": "John Doe",
"country": "US",
"dateOfBirth": "1980-01-15",
"confidence": 0.92,
"datasets": ["us_ofac_sdn"]
}
],
"sanctions": [],
"both": [],
"searchedSources": ["local", "opensanctions"]
}
POST /v1/screening/pep-sanctions
peps, sanctions, and both, and deduped by (name, dataset) with a confidence score.
Request
Headers
| Header | Required | Description |
|---|---|---|
x-api-key | Yes | Your API key |
Content-Type | Yes | application/json |
Body parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Individual’s email address |
firstName | string | Yes | Individual’s first name (1–255 chars) |
lastName | string | Yes | Individual’s last name (1–255 chars) |
dateOfBirth | string | Yes | Date of birth in YYYY-MM-DD format |
Example request
curl -X POST https://api.deepidv.com/v1/screening/pep-sanctions \
-H "Content-Type: application/json" \
-H "x-api-key: YOUR_API_KEY" \
-d '{
"email": "applicant@example.com",
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1980-01-15"
}'
const response = await fetch("https://api.deepidv.com/v1/screening/pep-sanctions", {
method: "POST",
headers: {
"Content-Type": "application/json",
"x-api-key": "YOUR_API_KEY",
},
body: JSON.stringify({
email: "applicant@example.com",
firstName: "John",
lastName: "Doe",
dateOfBirth: "1980-01-15",
}),
});
const data = await response.json();
import requests
response = requests.post(
"https://api.deepidv.com/v1/screening/pep-sanctions",
headers={
"Content-Type": "application/json",
"x-api-key": "YOUR_API_KEY",
},
json={
"email": "applicant@example.com",
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1980-01-15",
},
)
Response
200 — Success
| Field | Type | Description |
|---|---|---|
totalMatches | integer | Total number of matched records across all groups |
peps | array | Matches found only on PEP lists |
sanctions | array | Matches found only on sanctions lists |
both | array | Matches found on both PEP and sanctions lists |
searchedSources | array | Names of the datasets/sources that were queried |
peps, sanctions, and both has the following shape:
| Field | Type | Description |
|---|---|---|
name | string | Matched record name |
country | string | null | Country associated with the record, if known |
dateOfBirth | string | null | Date of birth on the record, if known |
confidence | number | Match confidence 0–1 (higher = stronger match) |
datasets | array | Source datasets that contributed this match |
Error responses
| Status | Description |
|---|---|
400 Bad Request | Request body failed schema validation |
401 Unauthorized | API key is invalid |
403 Forbidden | API key is missing or resource not in org |
404 Not Found | Referenced resource was not found |
500 Server Error | Unexpected server error |
{
"totalMatches": 1,
"peps": [
{
"name": "John Doe",
"country": "US",
"dateOfBirth": "1980-01-15",
"confidence": 0.92,
"datasets": ["us_ofac_sdn"]
}
],
"sanctions": [],
"both": [],
"searchedSources": ["local", "opensanctions"]
}
⌘I