# List policy rules

List policy rules for the specified wallet

Endpoint: GET /v2/vaults/{vaultId}/wallets/{walletId}/policy-rules
Version: 2.0
Security: TokenAuth

## Security:

  - `TokenAuth` (unknown)
    apiKey in header Authorization

## Path parameters:

  - `vaultId` (string, required)
    The vault ID

  - `walletId` (string, required)
    The wallet ID

## Query parameters:

  - `pageSize` (integer)
    The number of results to return per page (default 50, max 1000)

  - `pageToken` (string)
    The token to retrieve the next page of results

  - `pagination.pageSize` (integer)
    Number of results per page (default 50, max 1000)

  - `pagination.pageToken` (string)
    Token for pagination from previous response

  - `pagination.orderBy` (string)
    Field to order results by

  - `pagination.order` (string)
    Sort order (ASC or DESC)

  - `filter.id.eq` (string)
    Exact match

  - `filter.id.notEq` (string)
    Not equal to

  - `filter.id.contains` (string)
    Contains substring (case-insensitive)

  - `filter.id.startsWith` (string)
    Starts with prefix (case-insensitive)

  - `filter.id.endsWith` (string)
    Ends with suffix (case-insensitive)

  - `filter.id.in` (array)
    Value is in the list

  - `filter.id.notIn` (array)
    Value is not in the list

  - `filter.id.isNull` (boolean)
    Check if field is null

  - `filter.vaultId.eq` (string)
    Exact match

  - `filter.vaultId.notEq` (string)
    Not equal to

  - `filter.vaultId.contains` (string)
    Contains substring (case-insensitive)

  - `filter.vaultId.startsWith` (string)
    Starts with prefix (case-insensitive)

  - `filter.vaultId.endsWith` (string)
    Ends with suffix (case-insensitive)

  - `filter.vaultId.in` (array)
    Value is in the list

  - `filter.vaultId.notIn` (array)
    Value is not in the list

  - `filter.vaultId.isNull` (boolean)
    Check if field is null

  - `filter.walletId.eq` (string)
    Exact match

  - `filter.walletId.notEq` (string)
    Not equal to

  - `filter.walletId.contains` (string)
    Contains substring (case-insensitive)

  - `filter.walletId.startsWith` (string)
    Starts with prefix (case-insensitive)

  - `filter.walletId.endsWith` (string)
    Ends with suffix (case-insensitive)

  - `filter.walletId.in` (array)
    Value is in the list

  - `filter.walletId.notIn` (array)
    Value is not in the list

  - `filter.walletId.isNull` (boolean)
    Check if field is null

  - `filter.trigger` (string)
    Filter by rule trigger
- OUTBOUND_INITIATED: Any outbound operation submitted for policy evaluation before
signing (withdrawals, web3 transfers, palisade transfers, raw and
managed transactions) — not only value transfers.
- INBOUND_DETECTED: Any inbound activity observed on a monitored address (deposits and
other incoming operations detected by block monitoring).

  - `filter.assetId.eq` (string)
    Exact match

  - `filter.assetId.notEq` (string)
    Not equal to

  - `filter.assetId.contains` (string)
    Contains substring (case-insensitive)

  - `filter.assetId.startsWith` (string)
    Starts with prefix (case-insensitive)

  - `filter.assetId.endsWith` (string)
    Ends with suffix (case-insensitive)

  - `filter.assetId.in` (array)
    Value is in the list

  - `filter.assetId.notIn` (array)
    Value is not in the list

  - `filter.assetId.isNull` (boolean)
    Check if field is null

  - `filter.status` (string)
    Filter by policy rule status

  - `filter.active.eq` (boolean)
    Equals

  - `filter.active.isNull` (boolean)
    Check if field is null

  - `filter.createdAt.eq` (string)
    Exact timestamp match

  - `filter.createdAt.notEq` (string)
    Not equal to timestamp

  - `filter.createdAt.before` (string)
    Before this timestamp

  - `filter.createdAt.after` (string)
    After this timestamp

  - `filter.createdAt.gte` (string)
    Greater than or equal to timestamp

  - `filter.createdAt.lte` (string)
    Less than or equal to timestamp

  - `filter.createdAt.between.start` (string)
    Start of time range (inclusive)

  - `filter.createdAt.between.end` (string)
    End of time range (inclusive)

  - `filter.createdAt.isNull` (boolean)
    Check if field is null

  - `filter.createdAt.relativeDays` (integer)
    Relative days from now (negative for past, positive for future)

  - `filter.updatedAt.eq` (string)
    Exact timestamp match

  - `filter.updatedAt.notEq` (string)
    Not equal to timestamp

  - `filter.updatedAt.before` (string)
    Before this timestamp

  - `filter.updatedAt.after` (string)
    After this timestamp

  - `filter.updatedAt.gte` (string)
    Greater than or equal to timestamp

  - `filter.updatedAt.lte` (string)
    Less than or equal to timestamp

  - `filter.updatedAt.between.start` (string)
    Start of time range (inclusive)

  - `filter.updatedAt.between.end` (string)
    End of time range (inclusive)

  - `filter.updatedAt.isNull` (boolean)
    Check if field is null

  - `filter.updatedAt.relativeDays` (integer)
    Relative days from now (negative for past, positive for future)

  - `filter.kind` (string)
    Filter by rule kind

  - `search` (string)
    Case-insensitive search over policy rule ID, vault ID, wallet ID, and asset ID.

## Response 200:

  - `200` (unknown)
    A successful response.

## Response 200 fields (application/json):

  - `filter` (object)

  - `filter.previousPageToken` (string)
    The token to retrieve the previous page of results
    Example: cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=

  - `filter.nextPageToken` (string)
    The token to retrieve the next page of results
    Example: cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=

  - `filter.total` (integer, required)
    The total number of results
    Example: 100

  - `policyRules` (array)

  - `policyRules.id` (string)
    The policy rule ID
    Example: ce4918bf-a199-4ce2-85a3-d0d296855384

  - `policyRules.vaultId` (string, required)
    The vault ID
    Example: ce4918bf-a199-4ce2-85a3-d0d296855384

  - `policyRules.walletId` (string, required)
    The wallet ID the rule applies to
    Example: ce4918bf-a199-4ce2-85a3-d0d296855384

  - `policyRules.createdBy` (string)
    The original creator ID. Null or absent when unknown for a projected legacy approval default; required for ordinary rules.
    Example: ce4918bf-a199-4ce2-85a3-d0d296855384

  - `policyRules.trigger` (string, required)
    The transaction event the rule applies to. Approval defaults use OUTBOUND_INITIATED.
    Enum: "OUTBOUND_INITIATED", "INBOUND_DETECTED"

  - `policyRules.matchers` (array)

  - `policyRules.matchers.type` (string, required)
    Type of the matcher. ALL_COUNTERPARTIES accepts no `value` or `values` and matches only destinations resolved to a counterparty; omitting destination matchers leaves the destination unconstrained.
    Enum: "USER", "API_CREDENTIAL", "COUNTERPARTY", "TRANSACTION_TYPE", "SIGN_FOR", "COUNTERPARTY_ID", "ADDRESS_ID", "WALLET_ID", "CHAIN_ID", "ALL_COUNTERPARTIES"

  - `policyRules.matchers.value` (string)
    Comma seperated list of matcher values.

  - `policyRules.matchers.values` (array)
    Matcher values.

  - `policyRules.assetId` (string)
    The asset ID the rule applies to. Unset means any asset (wildcard), which is legal only without an amount condition.
    Example: 5:0xbehbehfb:USDC

  - `policyRules.status` (string)
    The policy rule status
    Enum: "RULE_CREATED", "RULE_ENABLED", "RULE_REJECTED", "RULE_DELETED", "RULE_ERROR", "RULE_CREATION_APPROVAL_PENDING", "RULE_CREATION_APPROVAL_COMPLETE", "RULE_DELETION_APPROVAL_PENDING", "RULE_DELETION_APPROVAL_COMPLETE"

  - `policyRules.active` (boolean)
    Whether the rule is active
    Example: true

  - `policyRules.createdAt` (string)
    The original creation time. Null or absent when unknown for a projected legacy approval default; required for ordinary rules.
    Example: 2022-03-29T10:22:22.420Z

  - `policyRules.updatedAt` (string)
    The date and time the policy rule was updated
    Example: 2022-03-29T10:22:22.420Z

  - `policyRules.definition` (object)

  - `policyRules.definition.kind` (string, required)
    Enum: "LIMIT"

  - `policyRules.definition.limit` (object, required)

  - `policyRules.definition.limit.amount` (object, required)

  - `policyRules.definition.limit.amount.threshold` (string, required)
    The amount threshold as a decimal string
    Example: 200.00

  - `policyRules.definition.limit.amount.operator` (string, required)
    The comparison operator applied to the threshold
    Enum: "GT", "GTE"

  - `policyRules.definition.limit.amount.aggregation` (string, required)
    The aggregation basis the threshold is evaluated over
    Enum: "SINGLE_TX", "ROLLING", "TOTAL"

  - `policyRules.definition.limit.amount.duration` (string)
    The rolling window duration. Set only when aggregation is ROLLING.
    Example: 86400s

  - `policyRules.definition.kind` (string, required)
    Enum: "TRAVEL_RULE"

  - `policyRules.definition.travelRule` (object, required)

  - `policyRules.definition.travelRule.travelRuleReleaseLevel` (string)
    Outbound TRAVEL_RULE rules only. Exchange milestone that releases the withdrawal: NEW (message exists at the provider), SENT (dispatched to the beneficiary VASP), ACK (beneficiary confirmed the address), or ACCEPTED (beneficiary accepted).
    Enum: "TRAVEL_RULE_RELEASE_LEVEL_NEW", "TRAVEL_RULE_RELEASE_LEVEL_SENT", "TRAVEL_RULE_RELEASE_LEVEL_ACK", "TRAVEL_RULE_RELEASE_LEVEL_ACCEPTED"

  - `policyRules.definition.travelRule.amount` (object)
    Optional single-transaction amount threshold. Omit it to require Travel Rule information for every matching transfer.

  - `policyRules.definition.travelRule.amount.threshold` (string, required)
    The amount threshold as a decimal string
    Example: 200.00

  - `policyRules.definition.travelRule.amount.operator` (string, required)
    The comparison operator applied to the threshold
    Enum: "GT", "GTE"

  - `policyRules.definition.travelRule.amount.aggregation` (string, required)
    The aggregation basis the threshold is evaluated over
    Enum: "SINGLE_TX", "ROLLING", "TOTAL"

  - `policyRules.definition.travelRule.amount.duration` (string)
    The rolling window duration. Set only when aggregation is ROLLING.
    Example: 86400s

  - `policyRules.definition.kind` (string, required)
    Enum: "APPROVAL"

  - `policyRules.definition.approval` (object, required)

  - `policyRules.definition.approval.amount` (object)
    Required for an ordinary step-up rule; absent for a wallet default.

  - `policyRules.definition.approval.amount.threshold` (string, required)
    The amount threshold as a decimal string
    Example: 200.00

  - `policyRules.definition.approval.amount.operator` (string, required)
    The comparison operator applied to the threshold
    Enum: "GT", "GTE"

  - `policyRules.definition.approval.amount.aggregation` (string, required)
    The aggregation basis the threshold is evaluated over
    Enum: "SINGLE_TX", "ROLLING", "TOTAL"

  - `policyRules.definition.approval.amount.duration` (string)
    The rolling window duration. Set only when aggregation is ROLLING.
    Example: 86400s

  - `policyRules.definition.approval.users` (object)
    Required for ordinary step-up rules and REQUIRE defaults; absent for NONE defaults.

  - `policyRules.definition.approval.users.userIds` (array, required)
    The approver user IDs
    Example: ["ce4918bf-a199-4ce2-85a3-d0d296855384"]

  - `policyRules.definition.approval.requiredApprovals` (integer)
    The number of distinct user approvals required. Positive for ordinary step-up rules and REQUIRE defaults; omitted or zero for NONE defaults.
    Example: 2

  - `policyRules.definition.approval.timeoutDuration` (string)
    Approval timeout duration. Defaults to 1 hour (3600s) if not specified. Minimum 5 minutes, maximum 24 hours.
    Example: 3600s

  - `policyRules.definition.approval.walletDefaultMode` (string)
    Present only for an asset-independent wallet transaction-approval default: REQUIRE explicit users/quorum, or NONE to suppress inherited approvals. Omission retains ordinary step-up semantics. Delete the resource to inherit.
    Enum: "REQUIRE", "NONE"

  - `policyRules.scope` (string)
    The owner of this resource: WALLET for ordinary rules and wallet defaults, ORGANIZATION for a read-only organization default projected into this wallet.
    Enum: "WALLET", "ORGANIZATION"

## Response 400:

  - `400` (unknown)
    Returned when the request is malformed or invalid.

## Response 400 fields (application/json):

  - `code` (integer)

  - `message` (string)

  - `details` (array)

  - `details.@type` (string)

## Response 401:

  - `401` (unknown)
    Returned when the request was unauthorized.

## Response 401 fields (application/json):

  - `code` (integer)

  - `message` (string)

  - `details` (array)

  - `details.@type` (string)

## Response 403:

  - `403` (unknown)
    Returned when the request was forbidden.

## Response 403 fields (application/json):

  - `code` (integer)

  - `message` (string)

  - `details` (array)

  - `details.@type` (string)

## Response 404:

  - `404` (unknown)
    Returned when the resource does not exist.

## Response 404 fields (application/json):

  - `code` (integer)

  - `message` (string)

  - `details` (array)

  - `details.@type` (string)

## Response default:

  - `default` (unknown)
    An unexpected error response.

## Response default fields (application/json):

  - `code` (integer)

  - `message` (string)

  - `details` (array)

  - `details.@type` (string)

## Response 400 examples:

  - `response` (unknown)

## Response 401 examples:

  - `response` (unknown)

## Response 403 examples:

  - `response` (unknown)

## Response 404 examples:

  - `response` (unknown)

