---
title: "Get TRLink policy"
method: GET
path: "/screening/trlink/policy"
tags: ["TRLink"]
---

# Get TRLink policy

`GET /screening/trlink/policy`

## Request

- Base URL: `https://api.fireblocks.io/v1`
- URL: `https://api.fireblocks.io/v1/screening/trlink/policy`
- Auth: none declared
- TypeScript: <https://skmtc.dev/fireblocks/apis/fireblocks-api/docs/screening/trlink/policy/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the complete TRSupport policy for the authenticated tenant, including pre-screening rules, post-screening rules, and missing TRM rules. Pre-screening rules determine whether transactions should be screened. Post-screening rules determine actions based on screening results. Missing TRM rules handle cases when screening data is unavailable.

## Response `200`

Policy retrieved successfully

- TRLinkPolicyResponse: TRLink policy response containing pre-screening, post-screening, and missing TRM rules
  - `preScreeningRules` TRLinkPreScreeningRule2[], required: Pre-screening rules that determine whether transactions should be screened
    - `customerId` string, nullable: Customer identifier
    - `direction` 'INBOUND' | 'OUTBOUND': Transaction direction from workspace perspective
    - `sourceType` string, nullable: Source entity type
    - `sourceSubType` string, nullable: Source entity subtype
    - `sourceAddress` string, nullable: Source blockchain address
    - `destType` string, nullable: Destination entity type
    - `destSubType` string, nullable: Destination entity subtype
    - `destAddress` string, nullable: Destination blockchain address
    - `sourceId` string, nullable: Source identifier
    - `destId` string, nullable: Destination identifier
    - `asset` string, nullable: Asset or cryptocurrency type
    - `baseAsset` string, nullable: Base asset for derivatives
    - `amount` ScreeningPolicyAmount: Amount specification with range and currency type (screening policy rules – BYORK, TRLink, etc.)
      - `range` ScreeningPolicyAmountRange, required: Minimum and maximum amount range specification
        - `min` string, nullable: Minimum amount (inclusive)
        - `max` string, nullable: Maximum amount (inclusive)
      - `currency` 'USD' | 'NATIVE', required
    - `networkProtocol` string, nullable: Network protocol identifier
    - `operation` string, nullable: Operation type
    - `description` string, nullable: Rule description
    - `isDefault` boolean, nullable: Whether this is a default rule
    - `action` 'SCREEN' | 'PASS', required
  - `postScreeningRules` TRLinkPostScreeningRule2[], required: Post-screening rules that determine actions based on screening results
    - `customerId` string, nullable: Customer identifier
    - `direction` 'INBOUND' | 'OUTBOUND': Transaction direction from workspace perspective
    - `sourceType` string, nullable: Source entity type
    - `sourceSubType` string, nullable: Source entity subtype
    - `sourceAddress` string, nullable: Source blockchain address
    - `destType` string, nullable: Destination entity type
    - `destSubType` string, nullable: Destination entity subtype
    - `destAddress` string, nullable: Destination blockchain address
    - `sourceId` string, nullable: Source identifier
    - `destId` string, nullable: Destination identifier
    - `asset` string, nullable: Asset or cryptocurrency type
    - `baseAsset` string, nullable: Base asset for derivatives
    - `amount` ScreeningPolicyAmount: Amount specification with range and currency type (screening policy rules – BYORK, TRLink, etc.)
      - `range` ScreeningPolicyAmountRange, required: Minimum and maximum amount range specification
        - `min` string, nullable: Minimum amount (inclusive)
        - `max` string, nullable: Maximum amount (inclusive)
      - `currency` 'USD' | 'NATIVE', required
    - `networkProtocol` string, nullable: Network protocol identifier
    - `operation` string, nullable: Operation type
    - `description` string, nullable: Rule description
    - `isDefault` boolean, nullable: Whether this is a default rule
    - `providerIdent` string, nullable: TRP provider identifier
    - `trmStatus` 'PENDING' | 'ACCEPTED' | 'REJECTED' | 'FAILED', nullable: Current status of the Travel Rule Message
    - `validBefore` number, nullable: Rule expires once this many seconds have elapsed since the wait/screening step started
    - `validAfter` number, nullable: Rule applies only after this many seconds have elapsed since the wait/screening step started
    - `action` 'ACCEPT' | 'ALERT' | 'REJECT' | 'WAIT', required
  - `missingTrmRules` TRLinkMissingTrmRule2[], required: Rules for handling transactions when TRM screening data is unavailable
    - `customerId` string, nullable: Customer identifier
    - `direction` 'INBOUND' | 'OUTBOUND': Transaction direction from workspace perspective
    - `sourceType` string, nullable: Source entity type
    - `sourceSubType` string, nullable: Source entity subtype
    - `sourceAddress` string, nullable: Source blockchain address
    - `destType` string, nullable: Destination entity type
    - `destSubType` string, nullable: Destination entity subtype
    - `destAddress` string, nullable: Destination blockchain address
    - `sourceId` string, nullable: Source identifier
    - `destId` string, nullable: Destination identifier
    - `asset` string, nullable: Asset or cryptocurrency type
    - `baseAsset` string, nullable: Base asset for derivatives
    - `amount` ScreeningPolicyAmount: Amount specification with range and currency type (screening policy rules – BYORK, TRLink, etc.)
      - `range` ScreeningPolicyAmountRange, required: Minimum and maximum amount range specification
        - `min` string, nullable: Minimum amount (inclusive)
        - `max` string, nullable: Maximum amount (inclusive)
      - `currency` 'USD' | 'NATIVE', required
    - `networkProtocol` string, nullable: Network protocol identifier
    - `operation` string, nullable: Operation type
    - `description` string, nullable: Rule description
    - `isDefault` boolean, nullable: Whether this is a default rule
    - `validBefore` number, nullable: Rule expires once this many seconds have elapsed since the wait/screening step started
    - `validAfter` number, nullable: Rule applies only after this many seconds have elapsed since the wait/screening step started
    - `action` 'WAIT' | 'REJECT' | 'ACCEPT', required: TRLink missing TRM action

## Other responses

- `default`: Error Response

---

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