Get all customers

Retrieves all customers associated with the authenticated tenant. Returns a list of legal entities configured for Travel Rule compliance.

GET /screening/trlink/customers

TypeScript

TypeScript

const response: Promise<FireblocksResponse<TRLinkCustomersListResponse>> = fireblocks.tRLink.getTRLinkCustomers();

200

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "tenantId": "550e8400-e29b-41d4-a716-446655440003",
    "discoverable": "discoverable",
    "shortName": "Acme Corp",
    "fullLegalName": "Acme Corporation Ltd.",
    "countryOfRegistration": "US",
    "createDate": "2025-01-20T10:30:00.000Z",
    "lastUpdate": "2025-01-24T08:45:00.000Z",
    "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"
    },
    "nationalIdentification": "{\"nationalIdentifierType\":\"LEIXG\",\"nationalIdentifier\":\"5493001KJTIIGC8Y1R12\",\"countryOfIssue\":\"US\"}",
    "dateOfIncorporation": "2015-03-15",
    "vaults": [
      0,
      1,
      2
    ],
    "trPrimaryPurpose": "Virtual asset service provider"
  }
]

Response

200

application/json

Customers retrieved successfully

id · string<uuid> · required

Customer unique identifier

Example:

"550e8400-e29b-41d4-a716-446655440001"

tenantId · string<uuid> · required

Fireblocks tenant ID

Example:

"550e8400-e29b-41d4-a716-446655440003"

discoverable · enum<string> | null · required

Customer discoverability status in the Travel Rule network

Available options: anonymous, hidden, discoverable

Example:

"discoverable"

shortName · string · required

Short display name

Example:

"Acme Corp"

fullLegalName · string · required

Full legal entity name

Example:

"Acme Corporation Ltd."

countryOfRegistration · string · required

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

Example:

"US"

createDate · string<date-time> · required

Timestamp when the customer was created (ISO 8601 format)

Example:

"2025-01-20T10:30:00.000Z"

lastUpdate · string<date-time> · required

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

Example:

"2025-01-24T08:45:00.000Z"

geographicAddress · object

Geographic address following IVMS101 standard

Show child attributes

nationalIdentification · string | null

National identification (serialized as string)

Example:

"{\"nationalIdentifierType\":\"LEIXG\",\"nationalIdentifier\":\"5493001KJTIIGC8Y1R12\",\"countryOfIssue\":\"US\"}"

dateOfIncorporation · string<date> | null

Date of entity incorporation (ISO 8601 format)

Example:

"2015-03-15"

vaults · integer[] | null

Associated Fireblocks vault account IDs

Example:

[0, 1, 2]

trPrimaryPurpose · string | null

Primary purpose for Travel Rule compliance

Example:

"Virtual asset service provider"