Rules

Deletes rules from the provided ids

Deletes rules and Returns a list of transfer rules that have been setup.

post/rules/delete

Request

Base URL
https://api.eu1.notabene.id
Auth
HTTP bearer
TypeScript
https://skmtc.dev/notabene/apis/notabene-api/docs/rules/delete/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

vaspDIDstring required

idsstring[] required

Response

Transfer Rule List

idstring uuid

Identifier of the transfer Rule

vaspDIDstring

Decentralized Identifier

ordernumber

Number that represents the order we should apply a rule per VASP

actionRule'APPROVE' | 'REJECT' | 'NOT_READY' | 'SEND_TO_INBOX'

Action of the rule

Condition to meet to have the action rule set

ruleValuestring

Value of the choosen rule

sourcestring

In the case of rule value beeing riskScore or sanctionListCheck, this is the field to fill with service provider

jurisdictionsstring[]

If ruleCheck is of type JURISDICTION, the list of jurisdictions involved in the rule will be returned

Example response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "vaspDID": "did:methd:identifier",
    "vasps": [
      {
        "did": "did:methd:identifier",
        "name": "Example VASP"
      }
    ],
    "jurisdictions": [
      "US,SG,BR"
    ]
  }
]

Changes

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