Sign in

v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB
Rules

List rules

Returns a list of transfer rules that have been setup.

get/rules/get

Query parameters

vaspDIDstring required

Decentralized Identifier

Example:did:methd:identifier

vaspDID to get list of transfer rules

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

ruleCheck'ALL' | 'VASP' | 'REVIEWED_VASP_LIST' | 'JURISDICTION' | 'RISK_SCORE' | 'SANCTION_LIST_CHECK' | 'TRANSACTION_AMOUNT' | 'TRANSACTION_CREATION_TIME'

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"
    ]
  }
]