Sign in

v1

latestOpenAPI 3.1.02026-07-241695611.0 MB
OFAC

Get Ofac Batch

Get the status of an OFAC batch.

get/ofac/searches/batches/{batch_id}

Path parameters

batch_idstring uuid required

The unique identifier of the OFAC batch to download.

Example:5b831224-0594-4e09-b26c-523c426f97a9

The unique identifier of the OFAC batch to download.

Response

Retrieved status of the OFAC batch.

idstring uuid required

The unique identifier of the OFAC batch.

namestring required

The name of the ofac batch file

similarity_thresholdnumber required

The similarity threshold for the OFAC search

state'PENDING' | 'EXECUTING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' required
entities_countinteger required

Total number of entities in the batch

valid_entities_countinteger required

Total number of valid entities in the batch

entities_with_match_countinteger required

Total number of entities with a match in the batch

invalid_entities_countinteger required

Total number of invalid entities in the batch

created_atstring date-time required

When the ofac batch was created

updated_atstring date-time nullable

When the ofac batch was updated

Example response

{
  "id": "b5d7c536-a153-4462-8297-cf6f00b90352",
  "name": "ofac_batch_1.csv",
  "similarity_threshold": 0.9,
  "entities_count": 100,
  "valid_entities_count": 100,
  "entities_with_match_count": 10,
  "invalid_entities_count": 10,
  "created_at": "2026-07-16T19:24:27.795831",
  "updated_at": "2026-07-16T19:24:27.795842"
}