---
title: "Get required actions for a TRM"
method: GET
path: "/screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/required_actions"
tags: ["TRLink"]
---

# Get required actions for a TRM

`GET /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/required_actions`

## Request

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

Retrieves the list of required actions (e.g., PII fields) needed to process the Travel Rule Message.

## Path parameters

- `customerIntegrationId` string, uuid, required
- `trmId` string, required

## Response `200`

Required actions retrieved successfully

- TRLinkGetRequiredActionsResponse: Response containing the list of required actions for a TRM
  - `actions` TRLinkRequiredAction[], required: List of required actions for the TRM
    - `type` string, required: The action type identifier as defined by the Travel Rule provider. Values are provider-specific and may vary across different TRP implementations, so this field is intentionally not restricted to a fixed set of values.
    - `description` string, nullable: Human-readable description of the action
    - `data` TRLinkRequiredActionData, nullable: Data describing what fields are required to resolve the action. The structure varies by action type and is defined by the TRP provider. For UPLOAD_BENEFICIARY_PII action type: Contains beneficiaryRequiredFields and/or originatorRequiredFields listing the IVMS101 field paths that must be provided.
      - `beneficiaryRequiredFields` TRLinkRequiredField[]: List of required beneficiary IVMS101 fields
        - `type` string, required: The person type for this field
        - `path` string, required: IVMS101 field path
      - `originatorRequiredFields` TRLinkRequiredField[]: List of required originator IVMS101 fields
        - `type` string, required: The person type for this field
        - `path` string, required: IVMS101 field path

## 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)