/ofac/parties/list

POST /api/ofac/parties/list

Price: 1 credit

List sanctioned parties from the US Treasury OFAC list

How to use it

List sanctioned parties from the US Treasury OFAC list in their published order, each with the full record (name, type, sanctions programs, aliases, addresses, identity documents, dates and places of birth, nationalities, citizenships, vessel details and remarks). Use list_type to choose between the main SDN list and the Consolidated (non-SDN) list.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• list_type string — Which OFAC list to read (default: "SDN"; one of: "SDN", "CONSOLIDATED")
• count integer required — Max result count (examples: 20; min: 1)

Response

• @type string (default: "OfacParty")
• uid integer required
• name string required
• sdn_type string nullable
• text string nullable
• programs array (default: [])
• akas array (default: [])
  • @type string (default: "OfacPartyAka")
  • uid integer nullable
  • type string nullable
  • category string nullable
  • name string nullable
• addresses array (default: [])
  • @type string (default: "OfacPartyAddress")
  • uid integer nullable
  • address1 string nullable
  • address2 string nullable
  • address3 string nullable
  • city string nullable
  • state_or_province string nullable
  • postal_code string nullable
  • country string nullable
• ids array (default: [])
  • @type string (default: "OfacPartyId")
  • uid integer nullable
  • id_type string nullable
  • id_number string nullable
  • country string nullable
  • issue_date string nullable
  • expiration_date string nullable
• dates_of_birth array (default: [])
• places_of_birth array (default: [])
• nationalities array (default: [])
• citizenships array (default: [])
• vessel_info object nullable
  • @type string (default: "OfacPartyVesselInfo")
  • call_sign string nullable
  • vessel_type string nullable
  • vessel_flag string nullable
  • vessel_owner string nullable
  • gross_registered_tonnage string nullable
  • tonnage string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.