Skip to main content
GET
/
screening
/
trlink
/
customers
/
integration
/
{customerIntegrationId}
/
trm
/
{trmId}
/
required_actions
TypeScript
const response: Promise<FireblocksResponse<TRLinkGetRequiredActionsResponse>> = fireblocks.tRLink.getTRLinkTrmRequiredActions(tRLinkApiGetTRLinkTrmRequiredActionsRequest);
CompletableFuture<ApiResponse<TRLinkGetRequiredActionsResponse>> response = fireblocks.tRLink().getTRLinkTrmRequiredActions(customerIntegrationId, trmId);
response = fireblocks.t_r_link.get_t_r_link_trm_required_actions(customer_integration_id, trm_id);
curl --request GET \
--url https://api.fireblocks.io/v1/screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/required_actions
const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/required_actions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fireblocks.io/v1/screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/required_actions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.fireblocks.io/v1/screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/required_actions"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/required_actions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "actions": [
    {
      "type": "UPLOAD_BENEFICIARY_PII",
      "description": "Provide beneficiary PII fields to process the TR message",
      "data": {
        "beneficiaryRequiredFields": [
          {
            "type": "naturalPerson",
            "path": "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier"
          }
        ],
        "originatorRequiredFields": [
          {
            "type": "naturalPerson",
            "path": "Beneficiary.beneficiaryPerson[].naturalPerson.name.nameIdentifier[].primaryIdentifier"
          }
        ]
      }
    }
  ]
}
{
"message": "<string>",
"code": 123
}

Path Parameters

customerIntegrationId
string<uuid>
required

Customer integration unique identifier

trmId
string
required

Travel Rule Message unique identifier

Response

Required actions retrieved successfully

Response containing the list of required actions for a TRM

actions
object[]
required

List of required actions for the TRM

Maximum array length: 10