Compliance

Screen a supplier name against public sanctions lists

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).

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

Query parameters

namestring

supplier name to screen (required)

aliasesstring

comma-separated alternative names

id_numberstring

an ID number to screen (optional)

id_schemestring

scheme for id_number, e.g. 'passport'; leave blank to screen the number under every scheme present on the loaded lists

dobstring

date of birth (individuals), optional; passed through as-is — ISO yyyy-mm-dd, dd Mon yyyy or a bare year are canonicalized downstream

proofsstring

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-Keystring

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.