Sanctions Screening API

Overview

The Ohmyfin Sanctions Screening API allows you to programmatically screen individuals and entities against comprehensive global sanctions lists. The API provides real-time fuzzy matching with configurable thresholds, supporting compliance workflows for financial institutions, fintechs, and businesses.

Base URL

https://ohmyfin.org/api/v4/sanctions

Authentication

All API requests require your API key in the KEY header. You can find your API key in your account settings after subscribing to a plan with API access.

KEY: your_api_key_here

Screen Endpoint

POST /api/v4/sanctions/screen

Screen an individual or entity name against all sanctions lists. Returns matching entries sorted by relevance score.

Request Parameters

Request Example

{
  "name": "John Smith",
  "threshold": 0.8,
  "max_results": 50
}

Response

{
  "success": true,
  "total_matches": 3,
  "matches": [
    {
      "entity_id": "ofac-12345",
      "name": "JOHN SMITH",
      "entity_type": "person",
      "list_source": "OFAC-SDN",
      "score": 0.95,
      "aliases": ["J. SMITH", "JOHNNY SMITH"],
      "nationalities": ["US"],
      "birth_dates": ["1970-01-15"],
      "addresses": [{"city": "New York", "country": "US"}],
      "identifications": [{"type": "Passport", "number": "AB123456"}],
      "programs": ["SDGT", "IRAN"],
      "remarks": "Additional details..."
    }
  ]
}

Response Fields

Entity Lookup

GET /api/v4/sanctions/entity/{entity_id}

Retrieve detailed information about a specific sanctioned entity by its unique identifier.

Response

Returns the full entity object with all available fields (same structure as individual match objects in the screen response).

Code Examples

• Python
• JavaScript
• cURL

import requests

response = requests.post(
    "https://ohmyfin.org/api/v4/sanctions/screen",
    headers={
        "KEY": "your_api_key",
        "Content-Type": "application/json"
    },
    json={
        "name": "John Smith",
        "threshold": 0.8,
        "max_results": 50
    }
)

result = response.json()
print(f"Found {result['total_matches']} matches")

for match in result['matches']:
    print(f"- {match['name']} ({match['score']*100:.0f}% match) - {match['list_source']}")

const response = await fetch('https://ohmyfin.org/api/v4/sanctions/screen', {
  method: 'POST',
  headers: {
    'KEY': 'your_api_key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'John Smith',
    threshold: 0.8,
    max_results: 50
  })
});

const result = await response.json();
console.log(`Found ${result.total_matches} matches`);

result.matches.forEach(match => {
  console.log(`- ${match.name} (${(match.score*100).toFixed(0)}% match) - ${match.list_source}`);
});

curl -X POST https://ohmyfin.org/api/v4/sanctions/screen \
  -H "KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Smith",
    "threshold": 0.8,
    "max_results": 50
  }'

Error Handling

Error Response Format

{
  "success": false,
  "error": "Description of what went wrong",
  "errors": {
    "name": ["The name field is required."]
  }
}

Rate Limits

Covered Sanctions Lists

Our database is updated daily and currently covers 278 sanctions lists, including:

Disclaimers