FIfireblocks
TRLink

Create customer

Creates a new customer (legal entity/VASP) for TRSupport Travel Rule compliance operations. The customer represents your organization in the Travel Rule network and contains IVMS101-compliant identity information.

post/screening/trlink/customers

Request

Headers

Idempotency-Keystring

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.

Request body

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

Customer discoverability status in the Travel Rule network

shortNamestring required

Short display name (required)

fullLegalNamestring nullable

Full legal entity name

countryOfRegistrationstring nullable

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

nationalIdentificationstring nullable

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.

dateOfIncorporationstring date nullable

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

vaultsinteger[] nullable

Associated Fireblocks vault account IDs

trPrimaryPurposestring

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

Example request

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

Response

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