Skip to content
Last updated

CHANGE LOG

2025-09-20 – Bank Match Product Launch
(Add)
New Product: Introduced the new Bank Match product to the API suite. Bank Match enables secure verification and matching of company and personal bank account details using IBAN or BBAN formats. This product supports compliance, fraud prevention, and onboarding processes by allowing you to validate bank account information for both companies and individuals.

  • Comprehensive documentation and integration guides are now available under the Product Documentation tab for Bank Match.
  • Endpoints include IBAN and BBAN search for both companies and individuals, as well as search criteria endpoints for supported countries and languages.
  • Bank Match Documentation

2025-06-01 – Local Solutions - UK - Verify Product Launch
(Add)
New Product: Introduced the new Verify product for the UK within Local Solutions. Verify enables enhanced due diligence and verification checks on business directors and individuals, supporting smarter and faster credit decisions.

  • Comprehensive documentation and process flows are now available under the Product Documentation tab for Verify.
  • Endpoints include individual and director search, as well as summary and full verification data retrieval.
  • Verify Documentation

All Updates

2025-11-17
(Update) Global Monitoring - Search Query Parameter Enhancement
Enhanced the searchQuery parameter documentation for the All Notification Events endpoint to clarify its multi-field search functionality. The search query now explicitly documents that it filters across Company Name, Country Code, Event Date, and Event ID fields. Added practical examples demonstrating how to search for specific events, companies, countries, and dates.
See details

(Update) KYC Protect - Reporting Enum Values Expansion

Added three new enum values to the reportType parameter for KYC Protect reporting endpoints to support additional report types:

  • amlScreen - Criteria for AML screening reports
  • monitorSearch - Criteria for monitoring search reports
  • profile - Criteria for profile-based reports

These values join the existing amlAlert and audit options, providing expanded reporting capabilities across AML screening, monitoring, and profile management.

Endpoints affected:

2025-11-12

(Update) Consumer & Misc - Consumer Report Enhancements

  • Added correlationId property to the top-level response for the Consumer Report endpoint to provide unique request tracking capability.
  • Added languages property to the consumer array response to indicate the language(s) used in the returned report data.
  • Enhanced the Consumer API documentation and endpoint descriptions to clarify response behavior:
    • The documented response schema represents the full set of possible fields that may be returned
    • Actual responses depend on data availability for the requested consumer
    • Fields with no available data will be omitted from the response
    • Developers should implement integrations to handle missing or partial data gracefully

Consumer & Misc Documentation
Consumer Endpoint
Consumer Report Response Schema

2025-11-05

(Update) Check & Decide - API Documentation Enhancements
Performed comprehensive updates to the Check & Decide API documentation to improve schema consistency and compliance:

  • Removed duplicate schema titles that were only detected during bundling configurations
  • Updated nullable properties to align with the OAS 3.1.0 standard
  • Fixed broken reference links to ensure example request bodies are now visible to customers (previously not displayed)
  • Updates affect most endpoints across the Check & Decide API

See details

Sanction Bodies Property Added:

Request Bodies:

Responses:

(Add) KYC Protect - New Endpoints and Audit Enhancements

  • GET Return Sanction Body Details
    Added a new administration resource endpoint to retrieve details of available sanction bodies for AML screening and monitoring.
    Return Sanction Body Details

  • GET AML Settings Preferences
    Added an endpoint to view the current AML settings preferences for a customer, including search types, actions, thresholds, datasets, and notification preferences.
    GET AML Settings Preferences

  • PUT AML Settings Preferences
    Added an endpoint to update AML settings preferences for a customer, allowing configuration of search types, actions, thresholds, datasets, sanction bodies, and notification preferences.
    PUT AML Settings Preferences

  • POST Create KYC Protect Alert
    Added a new endpoint to create KYC Protect alerts for companies or entities in AML monitoring.
    Create KYC Protect Alert

  • GET Return business links with supplier hit id
    Added an endpoint to retrieve business links using a supplier hit ID for AML screening.
    Return business links with supplier hit id

  • GET Return individual links with supplier hit id
    Added an endpoint to retrieve individual links using a supplier hit ID for AML screening.
    Return individual links with supplier hit id

  • GET Return business AML Copyrighted download URL
    Added an endpoint to retrieve copyrighted download URLs for business AML search results.
    Return business AML Copyrighted download URL

2025-10-28

(Update) Local Solutions - GB Finance Agreements
Added the excludeCutOffDate query parameter to the GB Finance Agreements endpoint, allowing users to optionally exclude the cut-off date from results.
See details

2025-10-28

(Update) Global Monitoring - Event Rule 101 Example Data
Updated the example data for Event Rule 101 to show param2 as a boolean value instead of alphanumeric on the following endpoints for portfolio ID in Global Monitoring:

2025-10-13
(Update) Global Monitoring - Portfolio Creation and Event Rules

  • Added information to the Create New Portfolio endpoint about the frequency property in the request body, clarifying that a string value of "1" is required to activate email notifications.
    See details
    This information is also available in the Global Monitoring help documentation.
  • Updated the Update Event Rules on a Portfolio endpoint with improved example data and additional detail on the use of param0, param1, and param2 properties, including guidance on where to find information about these parameters.
    See details

2025-09-23
(Update) OAS 3.0.4 Version Availability (Trial)
Added the option to download and view the OpenAPI specification in OAS 3.0.4 format for the following products:

2025-09-23
(Update) Credit & Risk - Company Report Endpoint Documentation
Added additional information to the Companies Report endpoint to clarify:

  • OpenAPI assumes that if a property is not marked as required, it is optional.
  • Not all properties will be returned in every response; properties with no value are omitted by design.
  • The endpoint provides core global response fields. For country-specific fields, use the Report Schema endpoint.
  • For further details, refer to the Companies help documentation.
    See details

2025-09-23
(Update) Credit & Risk - Company Search and Report ENUM Values
Updated the ENUM values for the officeType property in the company search and report schema (CreditsafeGlobalDataOfficeType) to use PascalCase instead of lowerCamelCase.
From:

  • registered
  • trading
  • headOffice
  • branch
  • subsidiary
  • franchise
  • franchisor
  • singleOffice
  • other

To:

  • Registered
  • Trading
  • HeadOffice
  • Branch
  • Subsidiary
  • Franchise
  • Franchisor
  • SingleOffice
  • Other

See details

2025-09-20
(Update) Credit & Risk - Confidence Match Search Response Descriptions
Added and enhanced property descriptions for the Confidence Match Search response schema to improve clarity and usability Confidence Match.

2025-09-20
(Add) Bank Match Product
Added the Bank Match product to the API catalog, providing endpoints for verifying and matching company and personal bank account details using IBAN or BBAN formats.

2025-09-20
(Add) Compliance Category in API Catalog
Introduced a new "Compliance" category in the API catalog. KYC Protect and Bank Match products now appear under this category for improved navigation and product grouping.
The API catalog can be accessed here: Catalog

2025-09-19
(Add) Global Monitoring - Global Coverage List
Added "Hong Kong" as a selectable option to the global coverage list for Global Monitoring.
See details

2025-09-19 (Update) Global Monitoring - Update Company Details in Portfolio
Updated the description for the personalLimit parameter in the Update Company Details in Portfolio request to clarify that it should be a string entry representing a positive. See Details

2025-09-19
(Update) Global Monitoring - Event Rules Documentation
Updated the documentation for the Global Monitoring event rules endpoint to clarify that it returns all available notification event rules, including those not currently enabled for a specific portfolio. Added guidance to use the Portfolio Event Rules endpoint to view only the rules available for companies in a given portfolio.
See details

2025-09-19
(Add) Global Monitoring - Special Event Rules Documentation
Added active links to the relevant event rule endpoints in the Special Event Rules documentation for easier navigation: All Event Rules, Event Rules Available Per Portfolio, and Filtered Event Rules (By Country Code). See details

2025-09-19
(Update) Global Monitoring - Portfolio Import and Sync Documentation
Added information and links to the help documentation for CSV structure and file size limits when importing or syncing portfolio files in Global Monitoring.
Endpoints Referenced:

2025-09-19
(Update) Home Page - Resource Links
Updated the resource links on the front home page to be active and open in a new window for easier access to key

2025-09-01 (Removal) Link to Legacy API Documentation in the Nav bar has been removed.

2025-08-15
(Update) Local Solutions - GB - Bank Verification - sortCodeDetails field

Added the sortCodeDetails property to Bank Verification responses to provide additional information about the returned sort code. Updated references to use the SortCodeCheckResponse schema and aligned descriptions for clarity and consistency.

Endpoints affected:

  • /localSolutions/GB/bankVerification/search See Details
  • /localSolutions/GB/bankVerification/history/{id}See Details

2025-08-15
(Add) Local Solutions - GB - Bank Verification - Sort Code Lookup Endpoint
Introduced a new endpoint to retrieve enhanced sort code information.

Endpoints affected:

  • /localSolutions/GB/bankVerification/sortCode/{id} See Details

2025-07-30
(Update) Documentation - Catalog Layout

The API Catalog layout has been updated to reflect the use of the tiles:

  • Authentication: Just for dedicated authentication information - The authenticate endpoint is present in every product to ensure available access
  • Featured: The primary way to view the Connect API and its associated documentation
  • Retained: Houses Legacy documentation and the older way to view the Connect API Documentation (Not the recommended method)

2025-07-28
(Update) Documentation - Special Event Rules
Enhanced documentation for Special Event Rules: clarified parameter descriptions and added example configurations for better understanding. See details

2025-07-28
(Add) KYC Protect - isDobRequired Property
Added the isDobRequired property to multiple KYC Protect schemas and endpoints to indicate if date of birth is required for individual searches.

See KYC Protect documentation

Endpoints affected:

  • /api/v1/Searches/individuals (PUT, POST, GET)
  • /api/v1/Searches/individuals/{searchId} (GET, PUT)
  • /api/v1/profiles/{profileId}/searches/bulk (POST)
  • /api/v1/profiles/{profileId}/searches/ (GET)
  • /api/v1/asyncAmlJobs/{jobId}/criteria (GET)
  • /api/v1/profiles/{profileId}/keyparties/searches/bulk (POST)
  • /api/v1/profiles/{profileId}/keyparties/searches (GET)
  • /api/v1/Schedules (PUT, POST, GET)
  • /api/v1/Schedules/{scheduleId} (GET, PUT)
  • /api/v1/Schedules/amlAlerts (GET)

2025-07-28
(Update) Documentation - Company Credit Report
Updated Accept header description and expanded response format options for Company Credit Report. See details

2025-07-28
(Add) Documentation - Rule 1703 - BE - Credit Score
Added description for Rule 1703 - BE - Credit Score to specify percentage value for notification trigger.

2025-07-28
(Update) Documentation - Credit and Risk Group Tag Name
Updated tag name for Credit and Risk group: changed 'Schema Structure' to 'Search And Report Schemas/Criteria'.
See details

2025-07-28
(Update) Documentation - Welcome Page
Enhanced documentation clarity and structure on the welcome page.

2025-07-28
(Update) Documentation - isProcessed Property
Updated description for isProcessed property to clarify its purpose in event notifications.
See details

2025-06-24
(Add) Portal - AI Assistance Tool
Introduced a new AI-powered assistance tool, accessible via the search option in the top right of the portal. Users can now click "Search with AI" to get help with general questions and guidance using all available documentation resources.

2025-06-24
(Update) Documentation - Decision Engine Flowchart
Updated the Decision Engine flowchart to reflect the latest process changes and improve clarity.

2025-06-01
(Add) Local Solutions - UK - Verify Product Launch
Introduced the new Verify product for the UK within Local Solutions. See details above in Featured Release.

2025-05-28
(Update) Documentation - Rate Limiting
Updated the Rate Limiting documentation to clarify burst and sustained rate limits, and added new examples for API usage scenarios.
Rate Limiting Documentation

2025-05-22
(Update) Documentation - Verify API Parameters
Clarified required and optional parameters for the Verify endpoints, including new guidance on date formats and address fields.

2025-05-20
(Add) Documentation - Director Search Guidance
Added a new section to the Verify documentation describing best practices for using the director search, including the use of the countries parameter and referencing the People and Director Search documentation.

2025-05-15
(Update) Check and Decide - Tag Descriptions
Added detailed descriptions for the tags in the Check and Decide OpenAPI specification to improve clarity and usability.
Check and Decide OpenAPI Specification

2025-05-12
(Update) Companies - Search and Report Process
Updated the example endpoints in the Search and Report Process documentation to include the missing prefix.
Companies Documentation

2025-05-10
(Add) Local Solutions - DE Non-Ltd Companies
Added three new endpoints for searching and retrieving non-limited company information in Germany:

  • GET /localSolutions/DE/nonLtdCompanies/searchcriteria
  • GET /localSolutions/DE/nonLtdCompanies
  • GET /localSolutions/DE/nonLtdCompanies/{id}
    Assistance documentation is available in the Product Documentation tab under Germany - Non-Limited Company Documentation.
    German Non-Ltd Company Documentation

2025-04-20
(Update) Local Solutions - UK - Consumer and AML Search
Updated the documentation for the UK Consumer and AML Search to clarify the pickList and consumerResult properties.
Consumer Search Documentation

2025-04-15
(Update) Information - Rate Limiting
Improved the structure and clarity of the Rate Limiting page to better explain global and endpoint-specific limits.
Rate Limiting Documentation

2025-04-10
(Update) Quick Start - API Documentation Links
Clarified that the image in the Getting Started section is not clickable and provided guidance on accessing OpenAPI files via the API Documentation tab in the sidebar.
File Updated: Quick Start - All Pages

2025-04-05
(Update) Access - Report Languages
Added detailed information about the availability of report languages and clarified that field content defaults to English if the selected language is unavailable.
Report Languages

2025-04-01
(Add) Information - 302 Error Code
Added documentation for the 302 error code to explain its purpose and usage in redirect scenarios.
Error Code Documentation

2025-03-01
No changes.

2025-02-20
(Update) Companies - Confidence Match Search
The matchThreshold parameter has been updated with new banding values:
Minimum value: 893, Maximum value: 999.
Endpoint: /companies/match

2025-02-15
(Update) GB Consumer - Multi-Bureau Search Request
The requestBody now uses camelCase for naming conventions. Additionally, two new parameters, sortCode and bankAccountNumber, have been added.
Endpoint: /localSolutions/GB/identitysearch

2025-02-10
(Fix) KYC - Return Full Search Hit Information
Corrected the schema response object type from a string to an array of strings.
Endpoints affected:

  • /kyc-protect/searches/individuals/{searchId}/hits/{hitId}
  • /kyc-protect/searches/businesses/{searchId}/hits/{hitId}

2025-01-20
(Fix) GB AML - Identity History
Corrected the casing of parameters on the GB Identity History endpoint.
Endpoint: /localSolutions/GB/identitysearch/history

Previous page