List Approvals

GET /v2/policy-approvals

Retrieves a list of approvals.

Required Permissions

NameConditions

Policies:Approvals:Read

Always Required

Parameters

Query parameters

Query string parameterRequired/OptionalDescriptionType

limit

Optional

Maximum number of items to return. Default to 20.

Positive Integer

paginationToken

Optional

Opaque token used to retrieve the next page. Returned as nextPageToken from the previous request.

String

status

Optional

Either Pending, Approved, Denied, AutoApproved or Expired.

Enumerated Type

triggerStatus

Optional

Triggered or Skipped.

Enumerated Type

initiatorId

Optional

The user ID of the activity initiator.

String

approverId

Optional

The user ID of a potential approver.

String

Response

Response example

Note: TriggerStatus of Skipped means the rule did not trigger for the given activity.

{
  "items":[
    {
      "id":"evl-...",
      "orgId":"or-...",
      "initiatorId":"us-...",
      "activityId":"xfr-...",
      "activityKind":"Wallets:Sign",
      "activity":{
        ...
      },
      "status":"Pending",
      "expirationDate":"2023-12-22T21:16:16.659Z",
      "dateCreated":"2023-12-22T20:56:16.662Z",
      "dateUpdated":"2023-12-22T20:56:16.662Z",
      "decisions":[
        {
          "userId":"us-...",
          "dateActioned":"2023-12-22T20:56:16.662Z",
          "value":"Approved"
        }
      ],
      "evaluatedPolicies":[
        {
          "policyId":"plc-...",
          "triggerStatus":"Triggered",
          "reason":"Number of transactions (2) is above limit (2)."
        },
        {
          "policyId":"plc-...",
          "triggerStatus":"Triggered",
          "reason":"Cumulative transfer amount (EUR 20) is above limit (EUR 2)."
        }
      ]
    }
  ],
  "nextPageToken":"ZxZ..."
}

Last updated