Skip to main content
GET
List Ofac Batches

Authorizations

X-API-Key
string
header
required

Query Parameters

limit
integer
default:10

Maximum number of records to return in a single page. Must be between 1 and 1000.

Required range: 1 <= x <= 1000
offset
integer | null

Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor.

Required range: x >= 0
cursor
string | null

Opaque pagination cursor token that identifies the position in the result set. Use the cursor from the previous response to get the next page. Cannot be used with offset.

Response

List of OFAC batches.

id
string<uuid>
required

The unique identifier of the OFAC batch.

Example:

"a2e702a1-34b6-4401-bc1c-2d5d07b2a957"

name
string
required

The name of the ofac batch file

Example:

"ofac_batch_1.csv"

similarity_threshold
number
required

The similarity threshold for the OFAC search

Required range: 0 <= x <= 1
Examples:

0.9

0.95

0.99

state
enum<string>
required

The current processing state of the ofac batch

Available options:
PENDING,
EXECUTING,
COMPLETED,
FAILED,
CANCELLED
Example:

"COMPLETED"

entities_count
integer
required

Total number of entities in the batch

Example:

100

valid_entities_count
integer
required

Total number of valid entities in the batch

Example:

100

entities_with_match_count
integer
required

Total number of entities with a match in the batch

Example:

10

invalid_entities_count
integer
required

Total number of invalid entities in the batch

Example:

10

created_at
string<date-time>
required

When the ofac batch was created

Example:

"2026-08-31T10:31:07.823202"

updated_at
string<date-time> | null

When the ofac batch was updated

Example:

"2026-08-31T10:31:07.823211"