Skip to main content
POST
/
screening
/
trlink
/
customers
TypeScript
const response: Promise<FireblocksResponse<TRLinkCustomerResponse>> = fireblocks.tRLink.createTRLinkCustomer(tRLinkApiCreateTRLinkCustomerRequest);
{
  "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
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developers.fireblocks.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Idempotency-Key
string

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Body

application/json
​
shortName
string
required

Short display name (required)

Example:

"Acme Corp"

​
discoverable
enum<string> | null

Customer discoverability status in the Travel Rule network

Available options:
anonymous,
hidden,
discoverable
Example:

"discoverable"

​
fullLegalName
string | null

Full legal entity name

Example:

"Acme Corporation Ltd."

​
geographicAddress
object

Geographic address following IVMS101 standard

​
countryOfRegistration
string | null

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

Example:

"US"

​
nationalIdentification
string | null

National identification, sent as a JSON-encoded string. The server normalizes input into a compact JSON with these optional keys: nationalIdentifier, nationalIdentifierType (e.g. LEIX for an LEI), countryOfIssue (ISO 3166-1 alpha-2), registrationAuthority. If the input is not a JSON object, it is wrapped as {"nationalIdentifier":"<value>"}; if the value matches the LEI format, nationalIdentifierType is set to LEIX automatically and countryOfIssue defaults to this request's countryOfRegistration if not provided. The compacted JSON must be 240 characters or fewer. On read, the value is returned exactly as stored.

Example:

"{\"nationalIdentifier\":\"EXAMPLELEI1234567890\",\"nationalIdentifierType\":\"LEIX\",\"countryOfIssue\":\"US\"}"

​
dateOfIncorporation
string<date> | null

Date of entity incorporation (ISO 8601 format: YYYY-MM-DD)

Example:

"2015-03-15"

​
vaults
integer[] | null

Associated Fireblocks vault account IDs

Example:
[0, 1, 2]
​
trPrimaryPurpose
string
default:trlink

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

Example:

"trlink"

Response

Customer created 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

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]