Skip to main content

Sanctions Screening

The Sanctions Screening API enables you to perform comprehensive searches for entities (individuals or organizations) to identify potential sanctions, adverse media mentions, and politically exposed person (PEP) status. This service is crucial for AML compliance and risk assessment.

Overview

Our sanctions screening service provides:

  • Real-time screening against multiple sanctions lists
  • Comprehensive adverse media checks
  • PEP (Politically Exposed Person) screening
  • Advanced name matching algorithms
  • Detailed risk scoring

Authentication

Before using the Sanctions Screening API, you must obtain an authentication token. Please refer to the Authentication documentation for detailed instructions on how to generate a token.

All API requests to the Sanctions Screening endpoints must include the authentication token in the Authorization header:

Authorization: Bearer your-token-here

Sanctions Search API

POST {base_url}/ExtSanctionScreening/Search
Content-Type: application/json
Authorization: Bearer your-token-here

Request Parameters

{
"entityType": "person",
"name": "John Doe",
"countries": [
"UK"
],
"entityDate": "1949-05-31"
}
ParameterTypeRequiredDescription
entityTypestringYesType of entity ("person" or "company")
namestringYesName of the entity to be screened
countriesarrayNoArray of ISO country codes
entityDatestringNoBirth/establishment date (YYYY-MM-DD format)

Response Structure

{
"version": null,
"statusCode": 200,
"messages": ["Processed successfully"],
"result": {
"id": null,
"name": "john doe",
"countries": "UK",
"entityType": "person",
"entityDate": "1949-05-31",
"createdAt": "2024-11-27T15:48:48.9211123Z",
"isKYCFilled": false,
"isActive": true,
"numOfHits": 23,
"sanctionSearchMappedResult": {
"searchDetails": {
"submitted_term": "john doe",
"total_hits": 0,
"total_matches": 0,
"searchSummary": {
"summaryDetail": {
"adverseMedia": 1517,
"pep": 5,
"sanctions": 7
},
"level": "Elevated",
"score": 70
}
},
"gridFeilds": [
{
"name": "Imran Ali Khan",
"countries": "Pakistan",
"riskType": "Sanctions, News Media",
"matchStatus": "match",
"riskScore": 70
}
]
}
}
}

Response Fields Explained

FieldDescription
result.nameName of the entity searched
result.countriesCountries associated with the entity
result.entityTypeType of entity ("person" or "company")
result.numOfHitsTotal number of hits identified
sanctionSearchMappedResult.searchDetailsDetailed information about the search
searchDetails.submitted_termThe term used for the search
searchSummary.summaryDetailCounts of different types of hits
searchSummary.levelRisk level classification
searchSummary.scoreOverall risk score (0-100)
gridFeildsArray of matching entities and their details

Best Practices

  1. Search Optimization:

    • Use full names when available
    • Include date of birth for individuals
    • Use country codes for better precision
  2. Result Handling:

    • Implement proper error handling
    • Store screening results for audit purposes
    • Implement regular re-screening
  3. Compliance:

    • Maintain screening audit logs
    • Document risk assessment decisions
    • Implement review procedures for matches
    • Regularly screen existing customers

Error Handling

Common error scenarios and their handling:

Status CodeScenarioRecommendation
400Invalid parametersCheck request format
401Authentication failureVerify API token
429Rate limit exceededImplement backoff
500Server errorRetry with exponential backoff