FIfireblocks
TRLink

Get customer by ID

Retrieves detailed information about a specific customer by their unique identifier.

get/screening/trlink/customers/{customerId}

Request

Path parameters

customerIdstring uuid required

Customer unique identifier

Response

Customer retrieved successfully

idstring uuid required

Customer unique identifier

discoverable'anonymous' | 'hidden' | 'discoverable' nullable required

Customer discoverability status in the Travel Rule network

shortNamestring required

Short display name

fullLegalNamestring required

Full legal entity name

countryOfRegistrationstring required

ISO 3166-1 alpha-2 country code where the entity is registered

nationalIdentificationstring nullable

National identification, returned exactly as stored: a compact, whitespace-free JSON-encoded string with these optional keys (in this order): nationalIdentifier, nationalIdentifierType (e.g. LEIX for an LEI), countryOfIssue (ISO 3166-1 alpha-2), registrationAuthority. Maximum length is 240 characters.

dateOfIncorporationstring date nullable

Date of entity incorporation (ISO 8601 format)

vaultsinteger[] nullable

Associated Fireblocks vault account IDs

trPrimaryPurposestring required

Primary Travel Rule role for this customer; determines how the customer's Travel Rule messages are routed. Valid values: notabene, trlink.

createDatestring date-time required

Timestamp when the customer was created (ISO 8601 format)

lastUpdatestring date-time required

Timestamp when the customer was last updated (ISO 8601 format)

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "discoverable": "discoverable",
  "shortName": "Acme Corp",
  "fullLegalName": "Acme Corporation Ltd.",
  "geographicAddress": {
    "addressLine": [
      "Suite 100"
    ],
    "streetName": "Main Street",
    "buildingNumber": "123",
    "floor": "5",
    "postBox": "PO Box 456",
    "postCode": "10001",
    "townName": "New York",
    "districtName": "Manhattan",
    "countrySubDivision": "NY",
    "country": "US"
  },
  "countryOfRegistration": "US",
  "nationalIdentification": "{\"nationalIdentifier\":\"EXAMPLELEI1234567890\",\"nationalIdentifierType\":\"LEIX\",\"countryOfIssue\":\"US\"}",
  "dateOfIncorporation": "2015-03-15",
  "vaults": [
    0,
    1,
    2
  ],
  "trPrimaryPurpose": "trlink",
  "createDate": "2025-01-20T10:30:00.000Z",
  "lastUpdate": "2025-01-24T08:45:00.000Z"
}

Changes

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