TRLink

Get customer integration by ID

Retrieves detailed information about a specific customer integration.

get/screening/trlink/customers/{customerId}/integrations/{customerIntegrationId}

Request

Path parameters

customerIdstring uuid required

Customer unique identifier

customerIntegrationIdstring uuid required

Customer integration unique identifier

Response

Customer integration retrieved successfully

customerIntegrationIdstring uuid required

Customer integration unique identifier

apiKeystring nullable

API key for partner integration (censored for security)

secretstring nullable

Secret for partner integration (censored for security)

createDatestring date-time required

Timestamp when the integration was created (ISO 8601 format)

lastUpdatestring date-time required

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

Example response

{
  "customerIntegrationId": "123e4567-e89b-12d3-a456-426614174000",
  "apiKey": "fb_***************",
  "secret": "***",
  "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",
    "description": "Travel Rule compliance provider",
    "baseUrl": "https://api.notabene.id",
    "active": true
  },
  "customer": {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "discoverable": "discoverable",
    "shortName": "Acme Corp",
    "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",
    "createDate": "2025-01-20T10:30:00.000Z",
    "lastUpdate": "2025-01-24T08:45:00.000Z"
  }
}

Changes

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