Create screening
curl --request POST \
--url https://api.beltic.com/v1/screenings \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"data": {
"type": "screening/politically-exposed-person",
"attributes": {
"execution_mode": "sync",
"query": {
"name_first": "John",
"name_last": "Doe",
"birthdate": "1985-01-15",
"country_code": "US"
}
}
}
}
'import requests
url = "https://api.beltic.com/v1/screenings"
payload = { "data": {
"type": "screening/politically-exposed-person",
"attributes": {
"execution_mode": "sync",
"query": {
"name_first": "John",
"name_last": "Doe",
"birthdate": "1985-01-15",
"country_code": "US"
}
}
} }
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
type: 'screening/politically-exposed-person',
attributes: {
execution_mode: 'sync',
query: {
name_first: 'John',
name_last: 'Doe',
birthdate: '1985-01-15',
country_code: 'US'
}
}
}
})
};
fetch('https://api.beltic.com/v1/screenings', 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.beltic.com/v1/screenings",
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([
'data' => [
'type' => 'screening/politically-exposed-person',
'attributes' => [
'execution_mode' => 'sync',
'query' => [
'name_first' => 'John',
'name_last' => 'Doe',
'birthdate' => '1985-01-15',
'country_code' => 'US'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-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.beltic.com/v1/screenings"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"screening/politically-exposed-person\",\n \"attributes\": {\n \"execution_mode\": \"sync\",\n \"query\": {\n \"name_first\": \"John\",\n \"name_last\": \"Doe\",\n \"birthdate\": \"1985-01-15\",\n \"country_code\": \"US\"\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-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.beltic.com/v1/screenings")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"type\": \"screening/politically-exposed-person\",\n \"attributes\": {\n \"execution_mode\": \"sync\",\n \"query\": {\n \"name_first\": \"John\",\n \"name_last\": \"Doe\",\n \"birthdate\": \"1985-01-15\",\n \"country_code\": \"US\"\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beltic.com/v1/screenings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"type\": \"screening/politically-exposed-person\",\n \"attributes\": {\n \"execution_mode\": \"sync\",\n \"query\": {\n \"name_first\": \"John\",\n \"name_last\": \"Doe\",\n \"birthdate\": \"1985-01-15\",\n \"country_code\": \"US\"\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"type": "screening/watchlist",
"id": "<string>",
"attributes": {
"query": {},
"has_match": true,
"created_at": "<string>",
"completed_at": "<string>",
"matched_lists": [
{
"name": "<string>",
"url": "<string>",
"list_type": "<string>",
"list_types": [
"<string>"
],
"slug": "<string>",
"flag_code": "<string>",
"country_code": "<string>",
"entities": [
{
"name": "<string>",
"alias_type": "<string>",
"birthdates": [
{
"day": "<string>",
"year": "<string>",
"month": "<string>",
"granularity": "<string>"
}
],
"birthdate": "<string>"
}
],
"match_types": [
"<string>"
]
}
],
"started_at": "<string>",
"errors": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"ignore_list": [
"<unknown>"
]
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "<string>"
}
},
"business": {
"data": {
"type": "business",
"id": "<string>"
}
}
}
}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"code": "<string>"
}
]
}Screening API
Create Screening
Create a new compliance screening request.
The data.type field determines the screening type and must be one of:
screening/politically-exposed-person: PEP screeningscreening/watchlist: Sanctions and watchlist screeningscreening/business-watchlist: Business sanctions screeningscreening/business-adverse-media: Business adverse media screening
Each type accepts a typed query object specific to that screening type.
Execution Modes:
async: Returns immediately with pending status, processes in background (default)sync: Waits for processing to complete (timeout: 55 seconds)
POST
/
v1
/
screenings
Create screening
curl --request POST \
--url https://api.beltic.com/v1/screenings \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"data": {
"type": "screening/politically-exposed-person",
"attributes": {
"execution_mode": "sync",
"query": {
"name_first": "John",
"name_last": "Doe",
"birthdate": "1985-01-15",
"country_code": "US"
}
}
}
}
'import requests
url = "https://api.beltic.com/v1/screenings"
payload = { "data": {
"type": "screening/politically-exposed-person",
"attributes": {
"execution_mode": "sync",
"query": {
"name_first": "John",
"name_last": "Doe",
"birthdate": "1985-01-15",
"country_code": "US"
}
}
} }
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
type: 'screening/politically-exposed-person',
attributes: {
execution_mode: 'sync',
query: {
name_first: 'John',
name_last: 'Doe',
birthdate: '1985-01-15',
country_code: 'US'
}
}
}
})
};
fetch('https://api.beltic.com/v1/screenings', 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.beltic.com/v1/screenings",
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([
'data' => [
'type' => 'screening/politically-exposed-person',
'attributes' => [
'execution_mode' => 'sync',
'query' => [
'name_first' => 'John',
'name_last' => 'Doe',
'birthdate' => '1985-01-15',
'country_code' => 'US'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-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.beltic.com/v1/screenings"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"screening/politically-exposed-person\",\n \"attributes\": {\n \"execution_mode\": \"sync\",\n \"query\": {\n \"name_first\": \"John\",\n \"name_last\": \"Doe\",\n \"birthdate\": \"1985-01-15\",\n \"country_code\": \"US\"\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-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.beltic.com/v1/screenings")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"type\": \"screening/politically-exposed-person\",\n \"attributes\": {\n \"execution_mode\": \"sync\",\n \"query\": {\n \"name_first\": \"John\",\n \"name_last\": \"Doe\",\n \"birthdate\": \"1985-01-15\",\n \"country_code\": \"US\"\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beltic.com/v1/screenings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"type\": \"screening/politically-exposed-person\",\n \"attributes\": {\n \"execution_mode\": \"sync\",\n \"query\": {\n \"name_first\": \"John\",\n \"name_last\": \"Doe\",\n \"birthdate\": \"1985-01-15\",\n \"country_code\": \"US\"\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"type": "screening/watchlist",
"id": "<string>",
"attributes": {
"query": {},
"has_match": true,
"created_at": "<string>",
"completed_at": "<string>",
"matched_lists": [
{
"name": "<string>",
"url": "<string>",
"list_type": "<string>",
"list_types": [
"<string>"
],
"slug": "<string>",
"flag_code": "<string>",
"country_code": "<string>",
"entities": [
{
"name": "<string>",
"alias_type": "<string>",
"birthdates": [
{
"day": "<string>",
"year": "<string>",
"month": "<string>",
"granularity": "<string>"
}
],
"birthdate": "<string>"
}
],
"match_types": [
"<string>"
]
}
],
"started_at": "<string>",
"errors": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"ignore_list": [
"<unknown>"
]
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "<string>"
}
},
"business": {
"data": {
"type": "business",
"id": "<string>"
}
}
}
}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"code": "<string>"
}
]
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"detail": "<string>",
"code": "<string>"
}
]
}Authorizations
API key for authentication. Access https://console.beltic.com/ to obtain your API key.
Body
application/json
- screening/politically-exposed-person
- screening/watchlist
- screening/business-watchlist
- screening/business-adverse-media
Show child attributes
Show child attributes
Example:
{
"type": "screening/politically-exposed-person",
"attributes": {
"execution_mode": "sync",
"query": {
"name_first": "John",
"name_last": "Doe",
"birthdate": "1985-01-15",
"country_code": "US"
}
}
}
Response
Screening created successfully
- screening/watchlist
- screening/politically-exposed-person
- screening/business-watchlist
- screening/business-adverse-media
Show child attributes
Show child attributes
Was this page helpful?
⌘I