---
title: "Screen a supplier name against public sanctions lists"
method: GET
path: "/v1/screen"
tags: ["Compliance"]
---

# Screen a supplier name against public sanctions lists

`GET /v1/screen`

## Request

- Base URL: `https://jp-verify.obolpay.xyz`
- URL: `https://jp-verify.obolpay.xyz/v1/screen`
- Auth: one of:
  - none
  - API key in header `X-API-Key`

Advisory supplier sanctions screening (OFAC/UN/EU/MOF; EXACT-match after
normalization with deterministic rule-generated variant expansion (keyset v2)
— still exact-match, NOT fuzzy, NOT a compliance program; see `disclaimer`).
Hits include advisory `matched_entities` attribution (source/uid/quality).

## Query parameters

- `name` string: supplier name to screen (required)
- `aliases` string: comma-separated alternative names
- `id_number` string: an ID number to screen (optional)
- `id_scheme` string: scheme for id_number, e.g. 'passport'; leave blank to screen the number under every scheme present on the loaded lists
- `dob` string: date of birth (individuals), optional; passed through as-is — ISO `yyyy-mm-dd`, `dd Mon yyyy` or a bare year are canonicalized downstream
- `proofs` string: set to '1' to include per-key Merkle non-membership proofs against `list_root` on a CLEAR result (third-party re-verifiable; hits carry no absence proofs)

## Headers

- `X-API-Key` string

## Response `200`

Successful Response

- unknown

## Other responses

- `400`: Malformed input — refused before metering; nothing was charged.
- `401`: Unknown, inactive, or expired API key.
- `422`: Validation Error
- `429`: Quota exceeded for the caller's tier.
- `503`: The register, or an optional feature, is unavailable or not configured on this deployment. A register 503 (since 1.4.1) also carries the mirror's `data_as_of` with the source fields — `source_latest_diff_date` (the newest 差分 the NTA 公表サイト listed when the sync last read it), `source_checked_at`, `source_gap_business_days` and `freshness.rule` (`stale` here) — so a caller can tell a mirror that is behind its source (`data_date` older than `source_latest_diff_date`) from a source that has not published (equal, but `source_checked_at` older than `freshness.source_check_max_hours`); `data_as_of` is null when the mirror is absent. Nothing was charged.

---

[API](https://skmtc.dev/obolpay/apis/jp-verify.md) · [All operations](https://skmtc.dev/obolpay/apis/jp-verify/llms.txt) · [OpenAPI document](https://skmtc.dev/obolpay/apis/jp-verify/revisions/bf8851690df0?raw)