BYO-Screening

Register YOUR sanctions-screening provider (owner-only) · 0 credits

Registers a screening provider under YOUR contract. Why it has to be yours and not ours: screening needs the parties' REAL names, before anonymisation — a sanctions list does not match [PERSON_1]. Sending those names to a third party is a transfer of personal data, and whoever contracts it has to be whoever answers for it. There is therefore NO provider of ours that calls a third party, and its absence is the design. The credential is WRITE-ONLY (AES-256-GCM, never returned). base_url is validated against SSRF. Scope: mcp | * (NOT cases).

post/api/v1/screening-providers

Request

  • Base URL: https://legal.nexusquantum.legal
  • URL: https://legal.nexusquantum.legal/api/v1/screening-providers
  • Auth: HTTP bearer

Request body

labelstring required

Required, 1–60 characters.

kind'opensanctions_compatible'

Default opensanctions_compatible.

base_urlstring required

Required; validated against SSRF.

api_keystring required

WRITE-ONLY. Required. Never returned.

listsstring[]

Up to 20 entries, 80 characters each.

enabledboolean

Default true.

Response

Provider created (no credential in the response).

idstring uuid
labelstring

How you will recognise this provider later (1–60).

kind'opensanctions_compatible'

Shape of the provider's API. Covers any endpoint exposing an equivalent /match.

base_urlstring

Your provider's endpoint (validated against SSRF).

key_fingerprintstring nullable

NON-reversible hash of the credential (e.g. sha256:a1b2c3d4). Not head+tail: on a short key, showing start and end reveals almost all of it. The credential itself NEVER leaves.

listsstring[]

The lists YOU declare as contracted. Shown to the reader verbatim. We do NOT verify them: the report says 'according to what your provider covers', never 'this is covered'.

enabledboolean
last_verified_atstring date-time nullable
created_atstring date-time
updated_atstring date-time

Changes

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