SanctionsLookup

Data last synced:

Request examples

Copy-paste samples for POST /v1/screen: a minimal JSON body, the same shape with options for score and result limits, a single subject with subject_ref, type, identifiers, and details, and a batch with two subjects of different types in one request.

Bare minimum

{
  "subjects": [
    {
      "name": "Kim Yong Un"
    }
  ]
}

Request with options

{
  "subjects": [
    {
      "name": "Kim Yong Un"
    }
  ],
  "options": {
    "min_score": 85,
    "max_results_per_subject": 5
  }
}

Request with identifiers and details

{
  "subjects": [
    {
      "name": "Kim Yong Un",
      "subject_ref": "customer_123",
      "type": "INDIVIDUAL",
      "identifiers": [
        { "value": "123456789" }
      ],
      "details": {
        "date_of_birth": "1984-01-08",
        "gender": "MALE"
      }
    }
  ],
  "options": {
    "min_score": 85,
    "max_results_per_subject": 3
  }
}

Small batch request

{
  "subjects": [
    {
      "name": "Kim Yong Un",
      "subject_ref": "customer_123",
      "type": "INDIVIDUAL"
    },
    {
      "name": "Rosneft",
      "subject_ref": "vendor_456",
      "type": "ENTITY"
    }
  ],
  "options": {
    "min_score": 80,
    "max_results_per_subject": 10
  }
}