Change Log

List of updates to the Connect API documentation.

November 2024

  • Removal of the GitHub link to the old Swagger UI - No longer supported.

    • Company Images

  • Endpoints updated to reflect correct responses and detailed descriptions added:
      • Endpoint /images/companies
    • 200 response re-written to remove incorrect properties.
    • 200 response re-written to include missing properties.
    • 200 response re-written to add descriptions for all properties.
      • Endpoint /images/{imageId}
    • 400 response corrected: Fixed `message` property structure.
    • 200 response updated: Returns a Binary Stream Response only; removed reference to incorrect schema.

    FR Bank Match

  • Additional parameter added:
      • Endpoint /localSolutions/FR/bankMatch
    • Added query parameter bankCountry.

    KYC Protect

  • Added integration assistance documentation in the 'Introduction' section.
  • Added guidance for best practices: Adding searches to profiles for monitoring.
  • New Endpoints added for AML and Audit Reporting, under a new sidebar option: KYC Reporting:
      • Endpoints:
    • GET /kyc-protect/reports/criteria/{type}
    • POST /kyc-protect/reports
    • GET /kyc-protect/reports
    • GET /kyc-protect/reports/{reportId}
    • GET /kyc-protect/reports/{reportId}/download
  • New Endpoints added for Business and Individual Search Hits, under new sidebar options: KYC AML Screening - Businesses and KYC AML Screening - Individuals:
      • Endpoints:
    • GET /kyc-protect/searches/businesses/{searchId}/hits/{hitId}/download
    • GET /kyc-protect/searches/individuals/{searchId}/hits/{hitId}/download

Protect - Legacy

  • Updated legacy Protect product endpoints:
      • Endpoints no longer supported:
    • All endpoints under /protect/*, except the following, now return a 301 Moved Permanently status:
      • POST /protect/audit
      • GET /protect/audit
      • POST /protect/idv/gdc/search
      • GET /protect/idv/file
      Response for deprecated endpoints:
      {"message": "All resources under /protect/* are no longer available. This product is now replaced by KYC Protect (/compliance/kyc-protect/* endpoints)"}
    • Removed unsupported endpoints from the documentation.