Create customer

post

https://api.fireblocks.io/v1/screening/trlink/customers

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.

Body Params

discoverable

string | null

enum

Customer discoverability status in the Travel Rule network

Allowed:

shortName

string

required

Short display name (required)

fullLegalName

string | null

Full legal entity name

geographicAddress

object | null

Geographic address following IVMS101 standard

countryOfRegistration

string | null

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

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.

dateOfIncorporation

date | null

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

vaults

array of integers | null

Associated Fireblocks vault account IDs

vaults

trPrimaryPurpose

string

Defaults to trlink

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

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.

Responses

201Customer created successfully

defaultError Response