neo-pays

Risk lists

Generated page, from the OpenAPI specification the gateway serves (GET /v1/openapi.json). Do not edit it by hand: it is rewritten on every build.

Method Path Description
POST /v1/risk/lists/{check}/{ruling} Add an allow- or deny-list entry
DELETE /v1/risk/lists/{id} Remove a list entry
GET /v1/risk/lists List your list entries

POST /v1/risk/lists/{check}/{ruling}

Add an allow- or deny-list entry

Adds an entry to one of your lists. check is the check targeted (policy, framl, harm, underage) and ruling is allow or deny.

⚠️ An entry forces the raw verdict of a CHECK, never the outcome of the transaction. Authority caps still apply: only policy and gate actually refuse, everything else is capped at REVIEW. The response's effect field tells you which immediately — it is the most useful field on this surface.

A deny on screening is recorded as a policy deny (translated_to_policy): refusing your own customer is not a sanctions finding. An allow on screening is refused: a sanctions match cannot be lifted from the merchant's side.

The subject is normalised with the same normaliser as the payment path. A name alone is never a list subject. Scope can_manage_risk_lists.

Parameters

Name In Required Description
check path yes
ruling path yes

Responses

  • 201 — Entry created
  • 403 — The can_manage_risk_lists scope is missing
  • 422 — Request not permitted — for example an allow on screening

DELETE /v1/risk/lists/{id}

Remove a list entry

Removes an entry YOU own. The removal is a new record, never a deletion: the history remains. An entry that is not yours answers 404.

Scope can_manage_risk_lists.

Parameters

Name In Required Description
id path yes
rationale query yes Required, as when adding.

Responses

  • 200 — Entry removed
  • 403 — The can_manage_risk_lists scope is missing
  • 404 — Entry unknown, or not owned by you

GET /v1/risk/lists

List your list entries

The entries you have written that are in force. Entries made by our teams never appear here. Scope can_manage_risk_lists.

Parameters

Name In Required Description
check query no

Responses

  • 200 — The entries
  • 403 — The can_manage_risk_lists scope is missing