Sanctions Screening API
Examples

Examples

The examples below demonstrate various use cases for the Sanctions Screening API. The examples are in the form of JSON request bodies which may be sent to the API via HTTP POST requests.

Example Request Code

curl 
-X POST https://api.ofac-api.com/v4/screen
-d '{"apiKey": "your-api-key", "source": ["SDN", "EU"], "cases": [{"name": "Abu Abbas"}]}' 
-H "Content-Type: application/json"

Example API Requests

  1. Screen a single name against the US OFAC SDN and European sanctions lists.
Request JSON
{
    "apiKey": "your-api-key",
    "minScore": 95,
    "sources": ["sdn", "nonsdn", "eu"],
    "cases": [
        {
            "name": "Abu Abbas"
        }
    ]
}
  1. Screen multiple names (batch) against the US OFAC SDN and European sanctions lists.
Request JSON
{
    "apiKey": "your-api-key",
    "minScore": 95,
    "sources": ["sdn", "nonsdn", "eu"],
    "cases": [
        {
          "name": "Abu Abbas"
        }, 
        {
          "name": "Sergei Vladilenovich"
        }
    ]
}
  1. Screen an individual and their passport.
Request JSON
{
    "apiKey": "your-api-key",
    "minScore": 95,
    "sources": ["sdn", "nonsdn", "eu"],
    "cases": [
        {
            "name": "Ayman Al Zawahiri",
            "identification": [
                {
                    "type": "passport",
                    "idNumber": "19820215"
                }
            ]
        }
    ]
}
  1. Screen a vessel by IMO number, filtering results to only vessels. Note that id.type is not required.
Request JSON
{
    "apiKey": "your-api-key",
    "sources": ["sdn"],
    "cases": [
        {
            "name": "Client Vessel",
            "identification": [
                {
                    "idNumber": "9167291"
                }
            ]
        }
    ]
}
API ResponseData Sources