Skip to main content
POST
/
api
/
ofac
/
parties
/ofac/parties
curl --request POST \
  --url https://api.anysite.io/api/ofac/parties \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "uid": 123,
  "timeout": 300,
  "list_type": "SDN"
}
'
[
  {
    "uid": 123,
    "name": "<string>",
    "@type": "@ofac_party",
    "title": "<string>",
    "sdn_type": "<string>",
    "text": "<string>",
    "programs": [],
    "akas": [],
    "addresses": [],
    "ids": [],
    "dates_of_birth": [],
    "places_of_birth": [],
    "nationalities": [],
    "citizenships": [],
    "vessel_info": {
      "@type": "@ofac_party_vessel_info",
      "call_sign": "<string>",
      "vessel_type": "<string>",
      "vessel_flag": "<string>",
      "vessel_owner": "<string>",
      "gross_registered_tonnage": "<string>",
      "tonnage": "<string>"
    }
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
uid
integer
required

OFAC record ID (numeric uid of the sanctioned party)

Examples:

9639

4238

​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
list_type
enum<string>
default:SDN

Which OFAC list to read the record from

Available options:
SDN,
CONSOLIDATED

Response

Successful Response

​
uid
integer
required
​
name
string
required
​
@type
string
default:@ofac_party
​
title
string | null
​
sdn_type
string | null
​
text
string | null
​
programs
string[]
​
akas
OfacPartyAka · object[]
​
addresses
OfacPartyAddress · object[]
​
ids
OfacPartyId · object[]
​
dates_of_birth
string[]
​
places_of_birth
string[]
​
nationalities
string[]
​
citizenships
string[]
​
vessel_info
OfacPartyVesselInfo · object