FIfireblocks
TRLink

Get required actions for a TRM

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

get/screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/required_actions

Request

Path parameters

customerIntegrationIdstring uuid required

Customer integration unique identifier

trmIdstring required

Travel Rule Message unique identifier

Response

Required actions retrieved successfully

Example response

{
  "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"
          }
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.