Create customer integration

Creates a new TRSupport integration for a customer. This establishes a connection placeholder between a customer and a Travel Rule partner. Use the connect endpoint to provide credentials after creation. You may optionally supply customerIntegrationId in the request body when your tenant is enabled for client-provided integration ids.

POST /screening/trlink/customers/integration

TypeScript

TypeScript

const response: Promise<FireblocksResponse<TRLinkCustomerIntegrationResponse>> = fireblocks.tRLink.createTRLinkIntegration(tRLinkApiCreateTRLinkIntegrationRequest);

201

{
  "customerIntegrationId": "123e4567-e89b-12d3-a456-426614174000",
  "createDate": "2025-01-20T10:30:00.000Z",
  "lastUpdate": "2025-01-24T08:45:00.000Z",
  "partner": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "ident": "notabene",
    "name": "Notabene",
    "baseUrl": "https://api.notabene.id",
    "active": true,
    "isTest": false,
    "description": "Travel Rule compliance provider"
  },
  "customer": {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "tenantId": "550e8400-e29b-41d4-a716-446655440003",
    "discoverable": "discoverable",
    "shortName": "Acme Corp",
    "fullLegalName": "Acme Corporation Ltd.",
    "countryOfRegistration": "US",
    "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": "{\"nationalIdentifierType\":\"LEIXG\",\"nationalIdentifier\":\"5493001KJTIIGC8Y1R12\",\"countryOfIssue\":\"US\"}",
    "dateOfIncorporation": "2015-03-15",
    "vaults": [
      0,
      1,
      2
    ],
    "trPrimaryPurpose": "Virtual asset service provider"
  },
  "apiKey": "fb_***************",
  "secret": "***"
}

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

customerId · string<uuid> · required

Customer unique identifier

Example:

"550e8400-e29b-41d4-a716-446655440001"

partnerIdent · string · required

Partner identification code (e.g., "sumsub", "notabene")

Example:

"sumsub"

customerIntegrationId · string<uuid>

Optional. When supplied and permitted for the tenant (feature flag / CSM arrangement), this value is used as the TRLink integration identifier instead of a server-generated UUID. If omitted, the API generates a UUID. If supplied when the tenant is not permitted to set a custom id, the request fails with 400. Contact your CSM if you need a custom integration id.

Example:

"660e8400-e29b-41d4-a716-446655440099"

Response

201

application/json

Customer integration created successfully

customerIntegrationId · string<uuid> · required

Customer integration unique identifier

Example:

"123e4567-e89b-12d3-a456-426614174000"

createDate · string<date-time> · required

Timestamp when the integration was created (ISO 8601 format)

Example:

"2025-01-20T10:30:00.000Z"

lastUpdate · string<date-time> · required

Timestamp when the integration was last updated (ISO 8601 format)

Example:

"2025-01-24T08:45:00.000Z"

partner · object · required

Show child attributes

customer · object · required

Show child attributes

apiKey · string | null

API key for partner integration (censored for security)

Example:

"fb_***************"

secret · string | null

Secret for partner integration (censored for security)

Example:

"***"