Sanctions Screening

The Sanctions Screening API allows you to screen individuals and entities against global sanctions lists, PEP (Politically Exposed Persons) databases, and adverse media sources to identify potential risks.

Authentication

All requests to this API require authentication using a bearer token in the Authorization header:

Authorization: Bearer your-token-here

For details on how to obtain an authentication token, please refer to the Authentication documentation.

Process Single Screening

POST {base_url}/ExtSanctions/ProcessSingleScreening

Request Body

{
  "name": "John Doe",
  "countries": ["UK"],
  "entityType": "person",
  "entityDate": "2024-05-31"
}

Parameters

Parameter	Type	Required	Description
name	string	Yes	Name of the individual or entity to screen (2-100 characters)
countries	array	No	Array of country codes to filter results
entityType	string	Yes	Type of entity ("person" or "company")
entityDate	string	No	Date of birth for individuals or establishment date for companies (YYYY-MM-DD)

Response

{
  "version": null,
  "statusCode": 200,
  "messages": [
    "Processed successfully"
  ],
  "result": {
    "id": null,
    "name": "John Doe",
    "countries": "UK",
    "entityType": "person",
    "entityDate": "2024-05-31",
    "bulkScreeningId": null,
    "createdById": null,
    "createdByName": null,
    "createdAt": "2025-05-08T12:57:48.6280329Z",
    "updatedAt": null,
    "isKYCFilled": false,
    "isActive": true,
    "numOfHits": 91,
    "sanctionSearchMappedResult": {
      "searchDetails": {
        "id": "",
        "lastScreened": "2025-05-08T12:57:48.9553731+00:00",
        "createdDate": "2025-05-08T12:57:48.9553731+00:00",
        "submitted_term": "John Doe",
        "isMonitored": false,
        "searchSummary": {
          "summaryDetail": {
            "adverseMedia": 4501,
            "sanctions": 0,
            "pep": 0
          },
          "level": "Elevated",
          "score": 80
        },
        "entity_urn": "3RJDNK75QCRRS"
      },
      "gridFeilds": [
        {
          "name": "John Doe",
          "countries": "United Kingdom",
          "riskType": "News Media",
          "matchStatus": "match",
          "strength": 1,
          "riskScore": 80
        },
        {
          "name": "John Doe",
          "countries": "",
          "riskType": "News Media",
          "matchStatus": "match",
          "strength": 1,
          "riskScore": 80
        }
      ]
    }
  }
}

Response Fields

Field	Type	Description
id	string	The identifier of the screening request (null for ad-hoc screening)
name	string	The name that was screened
countries	string	The countries used in the screening
entityType	string	Type of entity ("person" or "company")
entityDate	string	Date of birth or establishment date
createdAt	datetime	When the screening was performed
numOfHits	number	Total number of matches found
sanctionSearchMappedResult	object	Detailed results of the screening

Search Summary Fields

Field	Type	Description
adverseMedia	number	Count of adverse media mentions
sanctions	number	Count of sanctions list matches
pep	number	Count of politically exposed person matches
level	string	Risk level assessment ("Low", "Medium", "Elevated", "High")
score	number	Calculated risk score (0-100)

Grid Fields

Field	Type	Description
name	string	Name of the matched entity
countries	string	Countries associated with the match
riskType	string	Type of risk identified (e.g., "News Media", "Sanctions", "PEP")
matchStatus	string	Match status ("match", "false_positive", "confirmed")
strength	number	Match strength score (0-1)
riskScore	number	Risk score for this specific match (0-100)

Risk Level Types

Screening results can have the following risk levels:

Risk Level	Description
Low	Low risk assessment (score < 30)
Medium	Medium risk assessment (score 30-60)
Elevated	Elevated risk assessment (score 60-80)
High	High risk assessment (score > 80)

Entity Types

The following entity types are supported:

Entity Type	Description
person	Individual person
company	Business entity

Match Status Types

Matches can have the following status values:

Status	Description
match	Potential match requiring review
false_positive	Confirmed non-match
confirmed	Confirmed match

Error Handling

Status Code	Description	Solution
400	Invalid request parameters	Check request format
401	Unauthorized access	Check authentication token
429	Too many requests	Implement rate limiting