All notable changes to the Creditsafe Connect API documentation.
(Add) Information - Authentication Documentation
Added comprehensive authentication documentation page explaining JWT token-based authentication for Creditsafe Connect API, including:
- Detailed explanation of the authentication process and token lifecycle
- Token expiry information and refresh requirements (1-hour lifespan)
- Security best practices for credential management
- Troubleshooting guide for common authentication issues
- Example authentication flow with code samples See details
(Add) Information - Error Codes - 412 Precondition Failed
Added documentation for HTTP 412 (Precondition Failed) error code to the Error Codes reference page. This error occurs when conditional request headers (If-Match, If-None-Match, If-Modified-Since, If-Unmodified-Since) fail their validation on the server, commonly used in optimistic locking scenarios. See details
(Add) Information - Security Best Practices
Added new Security Best Practices documentation page covering:
- Network access configuration and IP whitelisting guidance (cloud-based service requires DNS-based restrictions)
- Recommended network configuration: HTTPS port 443 to
connect.creditsafe.com - Authentication security best practices
- Data security and encryption standards
- Rate limiting and monitoring guidance
- Compliance information and production deployment checklist See details
(Fix) Access - Authenticate Endpoint - 401 Response Schema
Corrected the 401 Unauthorized response schema for the Authenticate endpoint. The response structure has been updated to accurately reflect the error format returned when authentication fails due to invalid credentials. See details
(Update) Credit & Risk - UBO Data Location Update (Denmark Only)
Updated the location of UBO (Ultimate Beneficial Owner) information in the API response schema for Denmark. Previous Location: additionalInformation New Location: shareCapitalStructureExtra This change ensures better alignment with the schema structure and improves clarity for developers accessing UBO data specific to Denmark. Updated the documentation to reflect this change, including examples and guidance on accessing the shareCapitalStructureExtra property. See details
(Add) Schema Updates - KYCProtect
Updated 1 schema(s): KycProtectPostProfilesRequest. Addition of Nullable values to the properties.
- Endpoints: /compliance/kyc-protect/profiles See details
(Add) Credit & Risk - UK Company Report: FCA Data Documentation
- Added a dedicated documentation page describing how FCA (Financial Conduct Authority) properties are returned in UK company reports.
- The page details where FCA data appears in the API response, including both the
miscellaneousobject and thefcaDataarray within theadditionalInformationproperty. - Property descriptions and example response snippets are provided, along with notes on possible values for
fcaAuthorisationStatus. - FCA Data Documentation
(Update) Credit & Risk - UK IDV Product Documentation
- Added a dedicated documentation page for the UK IDV product’s
additionalDatafield, including property descriptions and guidance on handling country-specific response structures. - See details: UK IDV Additional Data Documentation
(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 reportsmonitorSearch- Criteria for monitoring search reportsprofile- Criteria for profile-based reports These values join the existingamlAlertandauditoptions, providing expanded reporting capabilities across AML screening, monitoring, and profile management. Endpoints affected:- GET Retrieve Report Criteria
- GET Return Report By Type
(Update) Consumer & Misc - Consumer Report Enhancements
- Added
correlationIdproperty to the top-level response for the Consumer Report endpoint to provide unique request tracking capability. - Added
languagesproperty 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
(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
(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:
- Access
- Credit and Risk
- Global Monitoring This is a trial for version availability. The OAS 3.0.4 version may be subject to change, as OAS 3.1.0 remains the main maintained version.
(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
(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
(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.
(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.
(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
(Add) Global Monitoring - Global Coverage List
Added "Hong Kong" as a selectable option to the global coverage list for Global Monitoring. See details
(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
(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
(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
(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:
(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
(Remove) Link to Legacy API Documentation in the Nav bar has been removed.
No description provided
(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/searchSee Details/localSolutions/GB/bankVerification/history/{id}See Details
(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
(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)
(Update) Documentation - Special Event Rules
Enhanced documentation for Special Event Rules: clarified parameter descriptions and added example configurations for better understanding. See details
(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)
(Update) Documentation - Company Credit Report
Updated Accept header description and expanded response format options for Company Credit Report. See details
(Add) Documentation - Rule 1703 - BE - Credit Score
Added description for Rule 1703 - BE - Credit Score to specify percentage value for notification trigger.
(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
(Update) Documentation - Welcome Page
Enhanced documentation clarity and structure on the welcome page.
(Update) Documentation - isProcessed Property
Updated description for isProcessed property to clarify its purpose in event notifications. See details
(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.
(Update) Documentation - Decision Engine Flowchart
Updated the Decision Engine flowchart to reflect the latest process changes and improve clarity.
(Add) Local Solutions - UK - Verify Product Launch
Introduced the new Verify product for the UK within Local Solutions. See details above in Featured Release.
(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
(Update) Documentation - Verify API Parameters
Clarified required and optional parameters for the Verify endpoints, including new guidance on date formats and address fields.
(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.
(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
(Update) Companies - Search and Report Process
Updated the example endpoints in the Search and Report Process documentation to include the missing prefix. Companies Documentation
(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/searchcriteriaGET /localSolutions/DE/nonLtdCompaniesGET /localSolutions/DE/nonLtdCompanies/{id}Assistance documentation is available in the Product Documentation tab under Germany - Non-Limited Company Documentation. German Non-Ltd Company Documentation
(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
(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
(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
(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
(Add) Information - 302 Error Code
Added documentation for the 302 error code to explain its purpose and usage in redirect scenarios. Error Code Documentation
(Update) No changes.
No description provided
(Update) Companies - Confidence Match Search
The matchThreshold parameter has been updated with new banding values: Minimum value: 893, Maximum value: 999. Endpoint: /companies/match
(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
(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}
(Fix) GB AML - Identity History
Corrected the casing of parameters on the GB Identity History endpoint. Endpoint: /localSolutions/GB/identitysearch/history