---
title: "Retrieves screening rules for connected provider of the given domain"
method: GET
path: "/v1/domains/{domainId}/compliance/providers/{provider}/screening-rules"
tags: ["Compliance"]
---

# Retrieves screening rules for connected provider of the given domain

`GET /v1/domains/{domainId}/compliance/providers/{provider}/screening-rules`

## Request

- Base URL: `https://docs.ripple.com` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.ripple.com/v1/domains/{domainId}/compliance/providers/{provider}/screening-rules`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/ripple/apis/ripple-custody-api/docs/v1/domains/:domainId/compliance/providers/:provider/screening-rules/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `domainId` string, uuid, required
- `provider` 'ELLIPTIC' | 'CHAINALYSIS', required

## Response `200`

OK

- ComplianceGetScreeningRulesResponse
  - `rules` union[]
    - union
      - ComplianceTransactionScreeningRuleElliptic
        - `transactionType` 'INCOMING' | 'OUTGOING', required
        - `lowRisk` ComplianceRiskLevelActionElliptic, required
          - `condition` 'EQUALS' | 'GREATER_THAN' | 'LESS_THAN' | 'GREATER_THAN_OR_EQUALS' | 'LESS_THAN_OR_EQUALS', required
          - `threshold` number, required
          - `action` 'APPROVE' | 'REJECT' | 'REQUIRE_EXPLICIT_DECISION', required
        - `highRisk` ComplianceRiskLevelActionElliptic, required
          - `condition` 'EQUALS' | 'GREATER_THAN' | 'LESS_THAN' | 'GREATER_THAN_OR_EQUALS' | 'LESS_THAN_OR_EQUALS', required
          - `threshold` number, required
          - `action` 'APPROVE' | 'REJECT' | 'REQUIRE_EXPLICIT_DECISION', required
      - ComplianceTransactionScreeningRuleChainalysis
        - `transactionType` 'INCOMING' | 'OUTGOING', required
        - `lowRisk` ComplianceRiskLevelActionChainalysis, required
          - `action` 'APPROVE' | 'REJECT' | 'REQUIRE_EXPLICIT_DECISION', required
        - `highRisk` ComplianceRiskLevelActionChainalysis, required
          - `action` 'APPROVE' | 'REJECT' | 'REQUIRE_EXPLICIT_DECISION', required
        - `mediumRisk` ComplianceRiskLevelActionChainalysis
          - `action` 'APPROVE' | 'REJECT' | 'REQUIRE_EXPLICIT_DECISION', required
        - `severeRisk` ComplianceRiskLevelActionChainalysis
          - `action` 'APPROVE' | 'REJECT' | 'REQUIRE_EXPLICIT_DECISION', required
        - `unknownRisk` ComplianceRiskLevelActionChainalysis
          - `action` 'APPROVE' | 'REJECT' | 'REQUIRE_EXPLICIT_DECISION', required
        - `unknownCategory` ComplianceRiskLevelActionChainalysis
          - `action` 'APPROVE' | 'REJECT' | 'REQUIRE_EXPLICIT_DECISION', required

## Other responses

- `400`: Bad Request
- `404`: Not Found

---

[API](https://skmtc.dev/ripple/apis/ripple-custody-api.md) - [All operations](https://skmtc.dev/ripple/apis/ripple-custody-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ripple/apis/ripple-custody-api/revisions/c6f0ad6b70c0?raw)