Compliance

Screen a supplier name against public sanctions lists (batch-friendly)

post/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

Headers

X-API-Keystring

Request body

namestring required

supplier name to screen

aliasesstring[] nullable

alternative names to also screen

dobstring nullable

date of birth (individuals), passed through as-is — ISO 'yyyy-mm-dd', 'dd Mon yyyy', or a bare year

proofsboolean nullable

include per-key Merkle non-membership proofs on a CLEAR result

Response

Successful Response

unknown required

Changes

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