Skip to main content
GET
TypeScript

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"

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: