Test connection

Tests the connection to a customer integration by validating stored credentials and attempting communication with the Travel Rule partner. Returns connection status and any error messages.

POST /screening/trlink/customers/integration/{customerIntegrationId}/test_connection

TypeScript

TypeScript

const response: Promise<FireblocksResponse<TRLinkTestConnectionResponse>> = fireblocks.tRLink.testTRLinkIntegrationConnection(tRLinkApiTestTRLinkIntegrationConnectionRequest);

200

{
  "success": true,
  "timestamp": "2025-01-24T10:30:00.000Z",
  "message": "Connection test failed: Invalid API key",
  "partnerIdent": "notabene",
  "partnerName": "Notabene"
}

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.

Path Parameters

customerIntegrationId · string<uuid> · required

Customer integration unique identifier

Response

200

application/json

Connection test completed (success or failure details in response body)

success · boolean · required

Whether the connection test was successful

Example:

true

timestamp · string<date-time> · required

Timestamp when the test was performed (ISO 8601 format)

Example:

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

message · string | null

Additional message about the connection test (present when success is false)

Example:

"Connection test failed: Invalid API key"

partnerIdent · string | null

Partner identification code

Example:

"notabene"

partnerName · string | null

Partner display name

Example:

"Notabene"