Create screening
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
Create screening
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
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