BYO-Screening

Enable/disable a screening provider or update its declared lists (owner-only) · 0 credits

Partial update. The CREDENTIAL IS NOT EDITABLE here: to rotate it, delete the provider and create it again, which leaves a trace instead of silently mutating a third party's key.

patch/api/v1/screening-providers/{id}

Request

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

Path parameters

idstring uuid required

Request body

enabledboolean
listsstring[]

Response

Provider updated (no credential).

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.