Create customer

POST

screening

trlink

customers

TypeScript

const response: Promise<FireblocksResponse<TRLinkCustomerResponse>> = fireblocks.tRLink.createTRLinkCustomer(tRLinkApiCreateTRLinkCustomerRequest);

curl --request POST \
  --url https://api.fireblocks.io/v1/screening/trlink/customers \
  --header 'Content-Type: application/json' \
  --data '
{
  "shortName": "Acme Corp",
  "discoverable": "discoverable",
  "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"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    shortName: 'Acme Corp',
    discoverable: 'discoverable',
    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'
  })
};

fetch('https://api.fireblocks.io/v1/screening/trlink/customers', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'shortName' => 'Acme Corp',
    'discoverable' => 'discoverable',
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/screening/trlink/customers"

	payload := strings.NewReader("{\n  \"shortName\": \"Acme Corp\",\n  \"discoverable\": \"discoverable\",\n  \"fullLegalName\": \"Acme Corporation Ltd.\",\n  \"geographicAddress\": {\n    \"addressLine\": [\n      \"Suite 100\"\n    ],\n    \"streetName\": \"Main Street\",\n    \"buildingNumber\": \"123\",\n    \"floor\": \"5\",\n    \"postBox\": \"PO Box 456\",\n    \"postCode\": \"10001\",\n    \"townName\": \"New York\",\n    \"districtName\": \"Manhattan\",\n    \"countrySubDivision\": \"NY\",\n    \"country\": \"US\"\n  },\n  \"countryOfRegistration\": \"US\",\n  \"nationalIdentification\": \"{\\\"nationalIdentifier\\\":\\\"EXAMPLELEI1234567890\\\",\\\"nationalIdentifierType\\\":\\\"LEIX\\\",\\\"countryOfIssue\\\":\\\"US\\\"}\",\n  \"dateOfIncorporation\": \"2015-03-15\",\n  \"vaults\": [\n    0,\n    1,\n    2\n  ],\n  \"trPrimaryPurpose\": \"trlink\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"shortName\": \"Acme Corp\",\n  \"discoverable\": \"discoverable\",\n  \"fullLegalName\": \"Acme Corporation Ltd.\",\n  \"geographicAddress\": {\n    \"addressLine\": [\n      \"Suite 100\"\n    ],\n    \"streetName\": \"Main Street\",\n    \"buildingNumber\": \"123\",\n    \"floor\": \"5\",\n    \"postBox\": \"PO Box 456\",\n    \"postCode\": \"10001\",\n    \"townName\": \"New York\",\n    \"districtName\": \"Manhattan\",\n    \"countrySubDivision\": \"NY\",\n    \"country\": \"US\"\n  },\n  \"countryOfRegistration\": \"US\",\n  \"nationalIdentification\": \"{\\\"nationalIdentifier\\\":\\\"EXAMPLELEI1234567890\\\",\\\"nationalIdentifierType\\\":\\\"LEIX\\\",\\\"countryOfIssue\\\":\\\"US\\\"}\",\n  \"dateOfIncorporation\": \"2015-03-15\",\n  \"vaults\": [\n    0,\n    1,\n    2\n  ],\n  \"trPrimaryPurpose\": \"trlink\"\n}"

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
}

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

Geographic address following IVMS101 standard

Show child attributes

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

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

Show child attributes

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]

⌘I

TypeScript

const response: Promise<FireblocksResponse<TRLinkCustomerResponse>> = fireblocks.tRLink.createTRLinkCustomer(tRLinkApiCreateTRLinkCustomerRequest);

curl --request POST \
  --url https://api.fireblocks.io/v1/screening/trlink/customers \
  --header 'Content-Type: application/json' \
  --data '
{
  "shortName": "Acme Corp",
  "discoverable": "discoverable",
  "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"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    shortName: 'Acme Corp',
    discoverable: 'discoverable',
    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'
  })
};

fetch('https://api.fireblocks.io/v1/screening/trlink/customers', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'shortName' => 'Acme Corp',
    'discoverable' => 'discoverable',
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/screening/trlink/customers"

	payload := strings.NewReader("{\n  \"shortName\": \"Acme Corp\",\n  \"discoverable\": \"discoverable\",\n  \"fullLegalName\": \"Acme Corporation Ltd.\",\n  \"geographicAddress\": {\n    \"addressLine\": [\n      \"Suite 100\"\n    ],\n    \"streetName\": \"Main Street\",\n    \"buildingNumber\": \"123\",\n    \"floor\": \"5\",\n    \"postBox\": \"PO Box 456\",\n    \"postCode\": \"10001\",\n    \"townName\": \"New York\",\n    \"districtName\": \"Manhattan\",\n    \"countrySubDivision\": \"NY\",\n    \"country\": \"US\"\n  },\n  \"countryOfRegistration\": \"US\",\n  \"nationalIdentification\": \"{\\\"nationalIdentifier\\\":\\\"EXAMPLELEI1234567890\\\",\\\"nationalIdentifierType\\\":\\\"LEIX\\\",\\\"countryOfIssue\\\":\\\"US\\\"}\",\n  \"dateOfIncorporation\": \"2015-03-15\",\n  \"vaults\": [\n    0,\n    1,\n    2\n  ],\n  \"trPrimaryPurpose\": \"trlink\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"shortName\": \"Acme Corp\",\n  \"discoverable\": \"discoverable\",\n  \"fullLegalName\": \"Acme Corporation Ltd.\",\n  \"geographicAddress\": {\n    \"addressLine\": [\n      \"Suite 100\"\n    ],\n    \"streetName\": \"Main Street\",\n    \"buildingNumber\": \"123\",\n    \"floor\": \"5\",\n    \"postBox\": \"PO Box 456\",\n    \"postCode\": \"10001\",\n    \"townName\": \"New York\",\n    \"districtName\": \"Manhattan\",\n    \"countrySubDivision\": \"NY\",\n    \"country\": \"US\"\n  },\n  \"countryOfRegistration\": \"US\",\n  \"nationalIdentification\": \"{\\\"nationalIdentifier\\\":\\\"EXAMPLELEI1234567890\\\",\\\"nationalIdentifierType\\\":\\\"LEIX\\\",\\\"countryOfIssue\\\":\\\"US\\\"}\",\n  \"dateOfIncorporation\": \"2015-03-15\",\n  \"vaults\": [\n    0,\n    1,\n    2\n  ],\n  \"trPrimaryPurpose\": \"trlink\"\n}"

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
}

Introduction

Errors & Statuses

API Endpoints

Data Objects

Headers

Body

Response