API Documentation

Overview

The AML Screen API provides programmatic access to sanctions list data from OFAC, UN, EU, UK, DFAT, ITA, and SECO. Use our REST API to search individuals and entities across global watchlists.

Base URL: https://api.amlscreen.io

Authentication

All API requests require an API key. Include your API key in the x-api-key header.

x-api-key: YOUR_API_KEY

You can contact us to request an API key.

Search Endpoint

POST /api/v1/search

Request Body

{
  "prompt": "search term",
  "search_type": "standard_match"  // optional
}

Parameters

ParameterTypeRequiredDescription
promptstringYesThe name or entity to search for
search_typestringNoSearch algorithm to use (defaults to fuzzy_search). Each search type has its own matching logic and threshold.

Available Search Types

fuzzy_search (default)

Vector-based similarity matching. Best for finding matches even with significant spelling variations, typos, or alternative spellings. Uses embeddings for semantic similarity.

permissive_match

Relaxed matching with high tolerance for variations. Catches more potential matches but may include more false positives. Good for comprehensive screening.

standard_match

Balanced approach between precision and recall. Recommended for most use cases. Provides a good mix of accuracy and coverage.

strict_match

High precision matching with low tolerance for variations. Returns only very close matches. Best when you need high confidence in results.

Example Request

curl -X POST https://api.amlscreen.com/api/v1/search \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "prompt": "John Smith",
    "search_type": "standard_match"
  }'

Response

{
  "search results": [
    {
      "search_result": {
        "match_type": "name",
        "name": "John Smith",
        "source_lists": [
          "OFAC Specially Designated Nationals (SDN) List",
          "UN Consolidated Sanctions List"
        ]
      }
    },
    {
      "search_result": {
        "match_type": "alias",
        "matched_alias": "J. Smith",
        "actual_name": "Jonathan Smith",
        "source_list": "EU Consolidated Sanctions List"
      }
    }
  ]
}

Error Codes

CodeDescription
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing API key
500Internal Server Error - Something went wrong

API Demo

You can test the API by using the Demo Playground to submit test requests.

Rate Limits

API keys are subject to fair use policies. Contact us for any feedback, questions, or requests.

We use cookies to improve your experience on our website. By browsing this website, you agree to our use of cookies.