Skip to main content
POST
/
sanctions
curl --request POST \
  --url https://api.getcurrent.ca/v1/sanctions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "Vladimir Putin"
}
'
{
  "meta": {
    "screeningId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "screenedAt": "2023-11-07T05:31:56Z",
    "duration": 1,
    "status": "completed",
    "submitted": {
      "query": "<string>",
      "typoTolerance": 0,
      "nameVariants": true,
      "entityType": "<string>",
      "countries": [
        "<string>"
      ],
      "sources": [
        "<string>"
      ],
      "dateOfBirth": "<string>"
    }
  },
  "screening": {
    "query": "<string>",
    "totalMatches": 1,
    "matches": [
      {
        "legalName": {
          "name": "<string>",
          "matchScore": 0.5
        },
        "alternateNames": [
          "<string>"
        ],
        "entityType": "<string>",
        "details": {
          "source": "<string>",
          "countries": [
            "<string>"
          ],
          "programs": [
            "<string>"
          ],
          "identifiers": [
            "<string>"
          ],
          "listingDate": "<string>",
          "dateOfBirth": "<string>",
          "remarks": "<string>"
        },
        "sourceUrls": [
          "<string>"
        ]
      }
    ]
  },
  "sourceCounts": {
    "ofacSdn": 123,
    "ofacConsolidated": 123,
    "caTerroristEntities": 123,
    "caAutonomousSanctions": 123,
    "euConsolidated": 123,
    "ukList": 123,
    "unConsolidated": 123,
    "nlTerrorism": 123,
    "auConsolidated": 123,
    "chSeco": 123
  },
  "errors": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true
  }
}

Authorizations

Authorization
string
header
required

API key as Bearer token: Authorization: Bearer cur_live_xxxxx

Body

application/json
query
string
required

Name of the person or entity to screen

Example:

"Vladimir Putin"

typoTolerance
enum<integer>
default:1

Number of character edits allowed when matching names. 0 = exact match only, 1 = one edit (default), 2 = two edits.

Available options:
0,
1,
2
nameVariants
boolean
default:true

Whether to also search common name variants and transliterations

entityType
enum<string>

Filter results to a specific entity type

Available options:
individual,
entity,
vessel,
aircraft
countries
string[]

Filter by ISO2 country codes (e.g. ["US", "RU"])

Example:
["RU"]
sources
enum<string>[]

Limit search to specific sanctions lists. Searches all sources when omitted.

Available options:
us-sanctions-ofac-sdn,
us-sanctions-ofac-consolidated,
ca-sanctions-terrorist-entities,
ca-sanctions-autonomous,
eu-sanctions-consolidated,
uk-sanctions-list,
un-sanctions-consolidated,
nl-sanctions-terrorism,
au-sanctions-consolidated,
ch-seco-sanctions
dateOfBirth
string

Date of birth in YYYY-MM-DD format (partial dates accepted)

Example:

"1970-01-15"

Response

Sanctions screening results

Standalone sanctions screening results with metadata, structured matches, and per-source hit counts

meta
object
required
screening
object
required

Screening results with query echo and match count

sourceCounts
object
required

Number of matches found per sanctions source

errors
object

Error details when status is "error", null on success