Skip to main content
GET
/
screening
/
trlink
/
customers
/
{customerId}
TypeScript
const response: Promise<FireblocksResponse<TRLinkCustomerResponse>> = fireblocks.tRLink.getTRLinkCustomerById(tRLinkApiGetTRLinkCustomerByIdRequest);
CompletableFuture<ApiResponse<TRLinkCustomerResponse>> response = fireblocks.tRLink().getTRLinkCustomerById(customerId);
response = fireblocks.t_r_link.get_t_r_link_customer_by_id(customer_id);
curl --request GET \
  --url https://api.fireblocks.io/v1/screening/trlink/customers/{customerId}
const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/screening/trlink/customers/{customerId}', 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/{customerId}",
  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/{customerId}"

	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/{customerId}")

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
{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "discoverable": "discoverable",
  "shortName": "Acme Corp",
  "fullLegalName": "Acme Corporation Ltd.",
  "countryOfRegistration": "US",
  "trPrimaryPurpose": "trlink",
  "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": "{\"nationalIdentifier\":\"EXAMPLELEI1234567890\",\"nationalIdentifierType\":\"LEIX\",\"countryOfIssue\":\"US\"}",
  "dateOfIncorporation": "2015-03-15",
  "vaults": [
    0,
    1,
    2
  ]
}
{
  "message": "<string>",
  "code": 123
}

Path Parameters

​
customerId
string<uuid>
required

Customer unique identifier

Response

Customer retrieved successfully

​
id
string<uuid>
required

Customer unique identifier

Example:

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

​
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"

​
trPrimaryPurpose
string
required

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

Example:

"trlink"

​
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 | null

Geographic address following IVMS101 standard

​
nationalIdentification
string | null

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.

Example:

"{\"nationalIdentifier\":\"EXAMPLELEI1234567890\",\"nationalIdentifierType\":\"LEIX\",\"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]