TRLink

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

Request

Base URL
https://api.fireblocks.io/v1
Auth
none declared
TypeScript
https://skmtc.dev/fireblocks/apis/fireblocks-api/docs/screening/trlink/customers/integration/:customerIntegrationId/test_connection/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

customerIntegrationIdstring uuid required

Customer integration unique identifier

Headers

Idempotency-Keystring

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.

Response

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

successboolean required

Whether the connection test was successful

messagestring nullable

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

timestampstring date-time required

Timestamp when the test was performed (ISO 8601 format)

partnerIdentstring nullable

Partner identification code

partnerNamestring nullable

Partner display name

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.