API Documentation

Everything you need to integrate the OFAC Search API

Endpoint Overview

POST /api/search

This endpoint accepts a JSON payload with search parameters and returns OFAC screening results.

Sample Request Payload


{
  "apiKey": "your-api-key",
  "ofacId": 123,
  "word1": "John",
  "word2": "Doe",
  "city": "New York",
  "country": "USA",
  "postalCode": "10001",
  "searchComments": "Initial screening"
}

Minimum 3 characters required across all fields. ofacId is mandatory.

CORS & Preflight

The API supports browser-based integrations with an OPTIONS handler at /api/search. This enables secure cross-origin requests from JavaScript clients.

Swagger UI

Explore and test the API interactively via Swagger:

Swagger

Response Format

The response includes match results, metadata, and a report summary. You can use this data to generate compliance reports or trigger alerts.


{
  "matches": [
    {
      "name": "John Doe",
      "score": 92,
      "listType": "SDN",
      "matchedFields": ["word1", "city"]
    }
  ],
  "reportId": "abc123",
  "timestamp": "2025-10-16T10:00:00Z"
}