Changelog

All notable changes to the Creditsafe Connect API documentation.

2026-11-06

(Update) Company Credit Report - Fields Added From Live Reports

The company report now documents fields that were returned in live reports but missing from the documentation, tested across 28 countries. There are no changes to the API itself.

Added companySummary.ggsId, safeNumber on group structure companies, address on extended group structure companies, isListed, leiRenewalDate and companyTaxNumbers in basic information, municipality on addresses, resignationDate on previous directors' positions, companyId on directorships, and grossProfit and costOfSales in other financials
userId is now documented as a string, as returned. It was previously documented as an integer
additionalInformation now lists the properties it commonly returns, such as commentaries, ratingHistory, companyHistory, enquiriesTrend and misc. Other properties can also be returned
Added the report sections companySummaryExtra, additionalInformationExtra, shareCapitalStructureExtra, localIndicators, localIndicatorsExtra and directorsAndDirectorships, and additionalData on share capital, shareholders, activities and directorships. Their properties vary by country: see the data dictionaries and the data availability per country file on Resource Links
Local financial statement ratios now lists salesNetWorkingCapital and liquidityRatioAcidTest
Company Credit Report now has a response example, taken from a real report and shortened, with personal details replaced. The top-level companyId, dateOfOrder, language and userId now have descriptions
Every report section and the fields inside them that had no description now have one, including the company summary, identification, credit score, contact information, directors, directorships, group structure, share capital and financial statements. Every parameter now has an example

If you generate client code, userId is now a string.

Company Credit Report endpoint reference
Retrieve FreshInvestigation Report Content endpoint reference
Create Profile From Company Report endpoint reference
Company Credit Report (Local Solutions) endpoint reference

2026-11-06

(Update) Credit & Risk - Country Coverage In Field Descriptions

Fields and filters that aren't available for every country no longer list the countries in their descriptions. They now link to the data dictionaries, which have the current coverage for each country. There are no changes to the API itself.

Company Search endpoint reference
Confidence Match Search endpoint reference
People/Director Search Criteria endpoint reference
Company Image Documents endpoint reference
Company Image endpoint reference

2026-11-06

(Fix) Credit & Risk - Company Credit Report Formats And Errors

The Company Credit Report formats and errors now match what the API returns. There are no changes to the API itself.

The Accept header now lists every format: application/json (the default), application/pdf, application/html, application/json+pdf, application/json+html and application/pdf+html, which returns the PDF only. The 200 response documents each of them
application/json+pdf returns correlationId, companyId and userId. They were previously documented as correlationID, companyID and userID. Added application/json+html, which returns the HTML report as htmlReportStream
400 has three shapes: messages for an unknown company id or a language the country doesn't support, a validation error with errors for a language code that doesn't exist, and the standard Connect error body for other errors. Each has an example. If you generate client code, the 400 body is now any of these shapes

Company Credit Report endpoint reference

2026-11-06

(Fix) Credit & Risk - Company Search Results And Criteria

Company Search and Company Search Criteria now match what the API returns, tested across 30 countries. There are no changes to the API itself.

companies[].name is the company's registered name. It was previously described as the name of the Ultimate Holding Company
Added the fields returned by some countries: previousNames, tradingNames, statusDescription, province, website, matchScore, id2, headquarters, fileNo, groupId, significantItems, industryCode, isMainOffice and isOffline, and in additionalInformation, branchNo, legalGroup, registeredCity and registrationKey
officeType and status can also be returned as headOffice, branch, other, active, Dissolved, Operations closed and Insufficient Information, depending on the country
tradingNames and website are a list in most countries and a single string in some
The status filter accepts Active or NonActive, in any case. The officeType filter's values depend on the country: use the values from Company Search Criteria. Not every country supports it
Added descriptions to the address, type, website, phoneNo and customData filters, including the format each accepts and the countries that support it
Every search parameter now has an example, and the response fields companies, totalSize, messages, address, officeType and additionalInformation have descriptions
Company Search Criteria: each field's rule now includes required. allowedValues can be returned as a single comma-separated string. Added the county and registeredCity address fields

Company Search endpoint reference
Company Search Criteria endpoint reference

2026-11-06

(Update) Credit & Risk - Search Criteria And Schema Endpoints Moved

To keep related endpoints together, the endpoints in the Search And Report Schemas/Criteria section have moved. Company Search Criteria, Report Schema Structure Per Country and the report languages endpoint are now under Companies. People/Director Search Criteria is now under People/Directors. Their page addresses have changed, so please update any bookmarks. There are no changes to the API itself. If you generate client code from the OpenAPI file, these operations now appear with the Companies and People/Directors operations, so references to the old grouping may need updating.

Company Search Criteria endpoint reference
Report Schema Structure Per Country endpoint reference
Return Languages Available For Company Reports For Selected Country endpoint reference
People/Director Search Criteria endpoint reference

2026-11-06

(Fix) Credit & Risk - Company Image Responses

These responses now match what the API returns. There are no changes to the API itself.

Company Image: the 200 response is the document as a binary file, not JSON. Its content type depends on the document's format, for example application/pdf or application/xhtml+xml. An imageId that isn't valid returns 400 with messages. If you generate client code, the 200 body is now a file and the 400 body is either the messages shape or the standard Connect error body
Company Image Documents: when the company has no documents, the response has messages and an empty companies list instead of data

The Images guide now lists the document types and formats each country returns, including Italy and Sweden, and explains that the image is returned as a file.

Company Image endpoint reference
Company Image Documents endpoint reference

2026-11-06

(Update) Error Response Descriptions

Every error response now has a description, using the standard HTTP name for the status: Bad Request, Unauthorized, Forbidden, Not Found, Conflict, Too Many Requests, Internal Server Error, Bad Gateway, Service Unavailable or Gateway Timeout. Where we know the specific reason, it follows the name. Many Credit & Risk error responses had no description, and a few KYC Protect descriptions used different wording. There are no changes to the API itself.

2026-11-06

(Fix) Credit & Risk - Search Criteria, Schemas, Match, Images And Languages

These responses now match what the API returns. There are no changes to the API itself.

People/Director Search Criteria: the response is now documented as countries and criteriaSets, the combinations of search fields you can use, with the rule for each field. It was previously documented as countriesCriteria. countries is required. The fields include fullName (used in some countries instead of first and last name), the company VAT number, and the company address, city, postcode, province and status fields used in Canada
Report Schema Structure Per Country: the 200 response is now documented as the list of JSON Schema documents for the country's company report
Confidence Match Search: the minimum matchThreshold is 890. Each matched company can include legalForm
Company Image Documents: publicationDate and additionalInformation.actionDate are local dates and times with no time zone offset, so publicationDate is no longer documented with the date-time format. If you generate client code, it's now a string. Added additionalInformation.source
Image Document Category Types: added criteriaSets, for countries that accept more than one kind of company id, and availableImageFormats
Return Languages Available For Company Reports For Selected Country: added correlationId
Get Fresh Investigations: added correlationId, and message, which is returned when nothing matches the search

Return Languages Available For Company Reports For Selected Country endpoint reference
Report Schema Structure Per Country endpoint reference
People/Director Search Criteria endpoint reference
Confidence Match Search endpoint reference
Company Image Documents endpoint reference
Image Document Category Types endpoint reference
Get Fresh Investigations endpoint reference

2026-11-06

(Fix) Authenticate - Error Responses

The Authenticate responses are now documented as the API returns them:

400 has two shapes. A missing, empty or wrongly typed username or password returns a validation error with ValidationErrors. A body that isn't valid JSON returns the standard Connect error body. Both have examples. If you generate client code, the 400 body is now either shape
401 is returned for a wrong username or password, with the RateLimit-remaining header that shows how many attempts are left
429 is now documented. It's returned after 5 invalid login attempts within 2 minutes
username and password are required, and the request body is required

The endpoint description now covers the token lifetime and the rate limit, with links to the Authentication and Rate Limiting guides. There are no changes to the API itself.

Authenticate endpoint reference

2026-11-05

(Update) KYC Protect - Where To Find Dataset And Sanction Body Values

In the search, monitoring and AML preference requests, datasets now links to the Dataset Definitions guide for the dataset codes, and sanctionBodies links to Return Sanction Body Details for the sanction body ids.

Request Multiple Searches Linked To A Key Party Asynchronously endpoint reference
Execute Bulk AML Screening endpoint reference
Execute An AML Search For An Individual And Save The Results To The Database endpoint reference
Update Schedules endpoint reference
Update A Schedule In Monitoring endpoint reference
Add Search To AML Monitoring endpoint reference
Update AML Preference Settings endpoint reference
Execute An AML Search For A Business And Saves The Results To The Database endpoint reference
Download A PDF File For A Business AML Screening endpoint reference
Download A PDF File For An Individual AML Screening endpoint reference

2026-11-05

(Update) KYC Protect - Permission Change Audits

The payload of RBAC audit entries now documents the fields returned when a role's permissions change (PermissionsChanged): roleId, modifiedBy, and oldPermissions and newPermissions, the permission codes the role was allowed before and after the change.

Return Audits endpoint reference

2026-11-05

(Add) KYC Protect - Gender On Profile Details

gender is now documented on profile details. You can set it when you create a profile and when you update its details, and it's returned with the details. Available values are male and female. It's only valid for the profile types Individual and SoleTrader: sending it for any other profile type is rejected with 400. Both requests now have examples for a company and for an individual profile.

Update Profile Details now explains that the request replaces all of the profile's details, so a field left out of the request is cleared. Its response website can be null.

Create Profile endpoint reference
Update Profile Details endpoint reference
Return Profile Details endpoint reference

2026-11-05

(Update) KYC Protect - Field Descriptions

Added descriptions to 291 fields that had none, across the KYC Protect requests and responses. They cover batch results (successful, failed, failedItem and error), paging fields (items and totalSize), async AML jobs and their criteria, the dataset groups in AML hit results (such as PEP, SAN and AM), and the details of each hit entry, such as sanctions, insolvencies, positions and events. There are no changes to the API itself.

2026-11-05

(Fix) KYC Protect - Return Compliance Alerts 403 Response

The 403 response is now documented as the API returns it: correlationId, message and details, with an example. It's returned when the account's subscription doesn't include compliance alerts (NotInSubscription). There are no changes to the API itself.

Return Compliance Alerts endpoint reference

2026-11-05

(Fix) KYC Protect - Team Not Found On Profiles

Added the 404 Team Not Found response to Create Profile, returned when the team in the X-Team-Id header doesn't exist or is being deleted. Return Profile By Profile Id now has examples of both of its 404 responses: profile not found, and team not found. There are no changes to the API itself.

Create Profile endpoint reference
Return Profile By Profile Id endpoint reference

2026-11-05

(Fix) KYC Protect - Failed Item Errors

The error object of each item in failed is now documented as the API returns it: message, a short summary, and details, more detail about why the item failed. It was previously documented with type, title, status, detail and instance, and on some endpoints with the placeholder fields additionalProp1, additionalProp2 and additionalProp3. Delete A Batch Of Key Parties now also documents the error of each failed item, and Update Individual AML Searches documents that assignedToUserId and note in a failed item can be null. There are no changes to the API itself.

2026-11-05

(Fix) KYC Protect - Responses Aligned With The API

These responses now match what the API returns. There are no changes to the API itself.

POST /compliance/kyc-protect/profiles/{profileId}/searches/bulk and POST /compliance/kyc-protect/profiles/{profileId}/keyparties/searches/bulk: the 202 response is now documented. It returns the async AML job that runs the searches, with its id, status and criteriaCount
correlationId is now documented on the responses of Update Batch Of Business AML Search Hits, Delete Searches From AML Monitoring, Add Profiles To Monitoring, Delete Profiles From Monitoring, Return Async AML Jobs By Id, Request Batch Upload, Return Batch Upload File Details, Download Batch Upload Error File and Update Role Permissions By Role Id
PUT /compliance/kyc-protect/searches/businesses/{searchId}/hits: supersededHit can be null
PUT /compliance/kyc-protect/profiles/{profileId}/keyparties: each failedItem now includes description, and its address can be null
POST /compliance/kyc-protect/profiles/businesses/import: report is now documented as the company report itself. It was previously documented as a full report response, with the report one level further down
DELETE /compliance/kyc-protect/profiles: added the 409 response, returned when a profile is locked

2026-11-05

(Fix) KYC Protect - Request Fields That Cannot Be Null

These request fields can't be null. The API rejects null with 400. They were previously documented as accepting null. There are no changes to the API itself.

items in the bulk search, key party bulk search, Add Profiles To Monitoring and Delete Profiles From Monitoring requests
status in the Update Status of Alert By Profile Id And Alert Id request
pepTiers in the Update AML Preference Settings request

Execute Bulk AML Screening endpoint reference
Request Multiple Searches Linked To A Key Party Asynchronously endpoint reference
Add Profiles To Monitoring endpoint reference
Delete Profiles From Monitoring endpoint reference
Update Status of Alert By Profile Id And Alert Id endpoint reference
Update AML Preference Settings endpoint reference

2026-11-05

(Update) KYC Protect - Update Role Permissions By Role Id

The endpoint now explains that the request must include every permission, and how to change only some of them by starting from Return Role Permissions By Role Id. It has a full request example, a success example, and examples of each 400 error and of the 404 for an unknown role.

Update Role Permissions By Role Id endpoint reference

2026-11-05

(Update) KYC Protect - Success Examples For Updating Roles Permissions

Update Roles Permissions and Modify Roles Permissions now have three response examples to choose from: every role updated, one role updated and one failed, and no role updated. Both requests also have examples for one role and for two roles.

Update Roles Permissions endpoint reference
Modify Roles Permissions endpoint reference

2026-11-05

(Fix) KYC Protect - Delete Responses Have No Body

The 204 responses of these endpoints are now documented with no body, as the API returns them. They were previously documented with a body: a boolean for Delete All Profiles, and an object with statusCode for deleting a key party. There are no changes to the API itself.

Delete All Profiles endpoint reference
Delete A Key Party By Key Party Id endpoint reference

2026-11-05

(Update) KYC Protect - How Batch, Bulk And Monitoring Endpoints Behave

The descriptions of these endpoints now explain how they behave:

Bulk searches on a profile must match the profile type, and the whole request is rejected otherwise
Assigning profiles in bulk fails as a whole if any profile doesn't exist, and leaving out userId removes the assignment
A batch upload is checked in the background. The error file is available once checking is done, and only an upload with insufficient credits can be retried
A profile can only be added to KYC monitoring if it has a Safe Number or company id, and the reasons a profile is listed in failed
A profile created from a company report is locked for about a minute, and can't be deleted or monitored until then
In a batch update of business hits, an unknown hit is listed in failed, while a missing hitId or decision rejects the whole request

Execute Bulk AML Screening endpoint reference
Assigns A List Of Profiles To User endpoint reference
Request Batch Upload endpoint reference
Download Batch Upload Error File endpoint reference
Retry Previous Upload endpoint reference
Add Profiles To Monitoring endpoint reference
Create Profile From Company Report endpoint reference
Update Batch Of Business AML Search Hits endpoint reference

2026-11-05

(Add) KYC Protect - Date Of Birth Matching On Bulk Searches

Added dobMatching to each search item in the bulk search requests. It sets how closely the date of birth must match: withinOneYear, sameYear or exact. If it's left out, sameYear is used. It only applies to individual searches.

Execute Bulk AML Screening endpoint reference
Request Multiple Searches Linked To A Key Party Asynchronously endpoint reference

2026-11-05

(Fix) KYC Protect - Hit Change History Field Name

The change date in each item of the hit change history is now documented as modifiedDateTime. It was previously documented as ModifiedDateTime. There are no changes to the API itself.

Return Change History For A Business Hit endpoint reference
Returns Change History For An Individual Hit endpoint reference

2026-11-04

(Add) KYC Protect - Teams Endpoints

New endpoints are now available to manage teams in KYC Protect. Teams group users and the records they work on, such as profiles and searches.

List the teams you belong to, and create, rename or delete a team
List the users in a team, and add or remove users with a role

A new Teams guide explains how teams work, including the X-Team-Id header, who can see which teams, the permission each endpoint needs and what happens when a team is deleted.

Teams Guide
List Teams endpoint reference
Create A Team endpoint reference
Update A Team endpoint reference
Delete A Team endpoint reference
List Team Users endpoint reference
Add Users To A Team endpoint reference
Delete Users From A Team endpoint reference

2026-11-04

(Add) KYC Protect - X-Team-Id Header

All KYC Protect endpoints now document the optional X-Team-Id request header. Send a team id from List Teams to work in that team. If the header is left out, the default team is used. Records created in a team can only be seen by sending that team's id. A team id that doesn't exist, or a team that is being deleted, is rejected with 404 Team Not Found.

List Teams endpoint reference

2026-11-04

(Fix) KYC Protect - Batch, Bulk And Monitoring Endpoints Aligned With The API

These endpoints now match the request and response definitions of the KYC Protect API. There are no changes to the API itself.

PUT /compliance/kyc-protect/searches/businesses/{searchId}/hits: each item in successful is now documented as the updated hit itself. It was previously documented as an object containing an items list. decision is now required in each request item, and items is required
GET /compliance/kyc-protect/batchUploads/{uploadId}: uploadId is now documented as a UUID string, previously an integer
POST /compliance/kyc-protect/profiles/{profileId}/searches/bulk and POST /compliance/kyc-protect/profiles/{profileId}/keyparties/searches/bulk requests: items is now required. Added isDobRequired to each item. type and gender now list their values
DELETE /compliance/kyc-protect/schedules, POST /compliance/kyc-protect/kycMonitoring/profiles/bulk and DELETE /compliance/kyc-protect/kycMonitoring/profiles requests: items is now required. The API rejects a request without it
PUT /compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts/{alertId} request: status is now required and lists its values (open, closedProcessed and closedUnprocessed). The response status of this endpoint and of GET /compliance/kyc-protect/kycMonitoring/profiles/{profileId}/alerts/{alertId} lists the same values
PUT /compliance/kyc-protect/settings/preferences/aml: added dobMatching to the request. searchType and searchActionType in the response now list their values
PUT /compliance/kyc-protect/profiles/assign/bulk: modeOfCreation, riskRating, status and type in each returned profile now list their values
GET /compliance/kyc-protect/profiles/{profileId}/schedules/{scheduleId}: added dobMatching and isDobRequired. gender and type now list their values
PUT /compliance/kyc-protect/batchUploads/{uploadId}/retry: status now lists its values
Fields that the API can return as null are now documented as nullable on these endpoints, and on GET /compliance/kyc-protect/asyncAmlJobs/{jobId}/criteria and GET /compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}/sources/{sourceId}/copyrighted/download
Added the 409 Conflict response to PUT /compliance/kyc-protect/settings/preferences/aml, PUT /compliance/kyc-protect/profiles/assign/bulk and the business copyrighted download, 404 Not Found to DELETE /compliance/kyc-protect/schedules, and 503 Service Unavailable to both hit change history endpoints

2026-11-04

(Fix) KYC Protect - Path Ids Documented As UUIDs

The profileId, searchId, hitId, noteId, sourceId and scheduleId path parameters are now documented with the uuid format on every KYC Protect endpoint that takes them. Some endpoints previously documented them as plain strings. A value that isn't a valid UUID is rejected with 404 Not Found. There are no changes to the API itself.

KYC Protect API reference

2026-11-04

(Fix) KYC Protect - Team Audit Details

GET /compliance/kyc-protect/authorization/audits now documents the payload fields returned on Team audits. There are no changes to the API itself.

Created: id, name, createdAt, createdById, modifiedAt and modifiedById
Updated: id, oldName, newName, oldDescription, newDescription, modifiedAt and modifiedById. oldDescription and newDescription can be null
Deleted: id, name, deletedAt and deletedById

Return Audits endpoint reference

2026-11-04

(Fix) KYC Protect - Search Link Fields That Can Be Null

These fields are now documented as nullable, because the API returns null when the value isn't known. There are no changes to the API itself.

GET /compliance/kyc-protect/searchLinks/businesses/{supplierHitId}: county in each address, and ownershipPercentage in each business link
GET /compliance/kyc-protect/searchLinks/individuals/{supplierHitId}: subCategory in each adverse media result

Return Business Links With Supplier Hit Id endpoint reference
Return Individual Links With Supplier Hit Id endpoint reference

2026-11-04

(Fix) KYC Protect - Not Found Responses

These endpoints now document the 404 Not Found response, which the API returns when an id in the path doesn't exist or isn't a valid id. There are no changes to the API itself.

GET /compliance/kyc-protect/profiles/{profileId}/keyparties/searches and DELETE /compliance/kyc-protect/profiles/{profileId}/keyparties/searches
POST /compliance/kyc-protect/profiles/{profileId}/details/addresses
POST /compliance/kyc-protect/profiles/{profileId}/searches/link
PUT /compliance/kyc-protect/searches/businesses/{searchId}
PUT /compliance/kyc-protect/schedules/{scheduleId}
GET /compliance/kyc-protect/batchUploads/{uploadId}
GET /compliance/kyc-protect/reports/{reportId} and GET /compliance/kyc-protect/reports/{reportId}/download

Return All Key Party Searches endpoint reference
Delete A Batch Of Key Party Searches endpoint reference
Create An Address For A Profile endpoint reference
Add AML Searches To The Given Profile endpoint reference
Update A Business AML Search By Search Id endpoint reference
Update A Schedule In Monitoring endpoint reference
Return Batch Upload File Details endpoint reference
Retrieve a Single Report by ID endpoint reference
Download a Report by ID endpoint reference

2026-11-04

(Fix) KYC Protect - Dates Of Birth On Search Hits

datesOfBirth on individual search hits is no longer documented with the date format. The API returns a full date (YYYY-MM-DD) or only a year (YYYY), as the field description already said, and a year alone isn't a valid date. The field is still a list of strings, and its description is unchanged. There are no changes to the API itself.

GET /compliance/kyc-protect/searches/individuals/{searchId}/hits and PUT /compliance/kyc-protect/searches/individuals/{searchId}/hits
GET /compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}, PUT /compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId} and PUT /compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}/note
GET /compliance/kyc-protect/schedules/amlAlerts and GET /compliance/kyc-protect/profiles/{profileId}/amlAlerts

Return Individual AML Search Hits endpoint reference
Update A Batch Of Individual AML Search Hits endpoint reference
Return Full Individual AML Search Hit Information By SearchId And HitId endpoint reference
Update A Single Individual Hit endpoint reference
Update The Note For A Single Individuals Hit endpoint reference
Return All Hits For A Schedule By Created Date endpoint reference
Return All Hits Linked To The Profile endpoint reference

2026-11-04

(Fix) KYC Protect - Superseded Hit Dates Of Birth Type

datesOfBirth in supersededHit is now documented as a list of strings, or null. It was previously documented as a single string. This matches datesOfBirth on the alert itself, which the API returns as a list. There are no changes to the API itself.

GET /compliance/kyc-protect/schedules/amlAlerts and GET /compliance/kyc-protect/profiles/{profileId}/amlAlerts: supersededHit.datesOfBirth in each alert

Return All Hits For A Schedule By Created Date endpoint reference
Return All Hits Linked To The Profile endpoint reference

2026-11-04

(Fix) KYC Protect - Null Allowed In Nullable Lists Of Values

Fields that are documented as nullable and have a fixed list of values now include null in that list. Previously the field allowed null but the list of values didn't, so a response containing null, which the API does return (for example pepTier on a hit), failed validation against the schema. The other values in each list are unchanged. There are no changes to the API itself.

Responses: gender and pepTier on individual search hits (GET /compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}, GET /compliance/kyc-protect/schedules/amlAlerts and GET /compliance/kyc-protect/profiles/{profileId}/amlAlerts), and gender and the pepTiers items in GET /compliance/kyc-protect/asyncAmlJobs/{jobId}/criteria
POST /compliance/kyc-protect/profiles request: type, status, riskRating and currencyCode
PUT /compliance/kyc-protect/profiles/{profileId} request: status and riskRating
PUT /compliance/kyc-protect/profiles/{profileId}/details request: currencyCode
POST /compliance/kyc-protect/profiles/{profileId}/details/addresses and PUT /compliance/kyc-protect/profiles/{profileId}/details/addresses/{addressId} requests: type
POST /compliance/kyc-protect/profiles/{profileId}/keyparties and POST /compliance/kyc-protect/searches/individuals requests: gender

2026-11-03

(Fix) KYC Protect - Field Types Corrected

Corrected the types of fields that were documented as objects. They are now documented as the strings, integers and dates the API returns, and each can be null. Their descriptions and formats are unchanged. There are no changes to the API itself.

PUT /compliance/kyc-protect/profiles/assign/bulk: internalId, assignedToId, assignedTo, safeNumber, companyId, formationDate, modifiedAt, modifiedById, modifiedBy, kycReviewOn, kycStatusUpdatedOn, kycComments and importStatus in each returned profile
GET /compliance/kyc-protect/profiles/{profileId}/searches: name, assignedToUserId, assignedUser, note, firstName, middleName, lastName, gender, dateOfBirth and scheduleId in each search
GET /compliance/kyc-protect/profiles/{profileId}/schedules/{scheduleId}: name, firstName, middleName, lastName, gender and dateOfBirth
PUT /compliance/kyc-protect/searches/individuals request: assignedToUserId, status, riskRating and note in each item
POST /compliance/kyc-protect/reports request: criteria is now documented as an object of name and value pairs matching GET /compliance/kyc-protect/reports/criteria/{type}. It previously documented a single property named additionalProperties

Assigns A List Of Profiles To User endpoint reference
Return List Of AML Searches On The Given Profile endpoint reference
Return Schedule By ProfileId And ScheduleId endpoint reference
Update Individual AML Searches endpoint reference
Create AML / Audit Report endpoint reference

2026-11-03

(Fix) KYC Protect - Audit Categories, Subcategories and Actions

The GET /compliance/kyc-protect/audits endpoint now documents the full lists of audit categories, subcategories and actions. These apply to the categories, subcategories and actions filters and to each returned audit. There are no changes to the API itself.

Categories: added settings, uploads, bulkImport and team, so the full list is profile, amlSearch, settings, uploads, bulkImport and team
Subcategories: added profile, searchHit, preferences and emailPreferences. The subcategory of a returned audit can also be null
Actions: added alertUpdated, addedToKycMonitoring, removedFromKycMonitoring, reportDownloaded, viewed, companyReportAttached, alertReceived, recharged, aborted, completed and dataMovedBetweenTeams

Return Audit Trail endpoint reference

2026-11-03

(Fix) KYC Protect - Request Bodies Corrected

Corrected three request bodies to match what the API accepts. Requests that follow the previous documentation could fail. There are no changes to the API itself.

POST /compliance/kyc-protect/profiles: details is now documented as required, and must include legalName. The API rejects a request without details
PUT /compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}: the request body is now documented as application/json, previously multipart/form-data. The API does not accept multipart/form-data on this endpoint
POST /compliance/kyc-protect/profiles/{profileId}/details/addresses: description is now documented as optional. Only type is required

Create Profile endpoint reference
Update Profile Attachment By Profile And Attachment Id endpoint reference
Create An Address For A Profile endpoint reference

2026-11-03

(Fix) KYC Protect - Individual Hit Update and Monitoring Response Structures

Corrected two response structures to match the responses returned by the API. There are no changes to the API itself.

PUT /compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId} and PUT /compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}/note: the updated hit is now documented at the top level of the response. Previously its fields were documented inside an items object, which the API does not return. profileImages is now documented as an array, and supersededHit can be null
POST /compliance/kyc-protect/schedules: each item in successful is now documented as a single schedule, matching GET /compliance/kyc-protect/schedules/{scheduleId}. Previously each item was documented as a list of schedules
All schedule responses now share the same schedule structure. In GET /compliance/kyc-protect/schedules and POST /compliance/kyc-protect/schedules, name, firstName, middleName, lastName, gender, dateOfBirth, countries, emailRecipients and pepTiers can now be null, as already documented for GET /compliance/kyc-protect/schedules/{scheduleId}. GET /compliance/kyc-protect/profiles/{profileId}/schedules now also documents isDobRequired and dobMatching for each schedule

Update A Single Individual Hit endpoint reference
Update The Note For A Single Individuals Hit endpoint reference
Add Search To AML Monitoring endpoint reference
Return All Ordered Schedules endpoint reference
Return All Schedules By ProfileId And Modified Date endpoint reference

2026-11-03

(Fix) KYC Protect - Response Fields, Types and Status Codes Aligned with API Responses

Added fields that the API already returns, and corrected field types and status codes, so the responses match the API. There are no changes to the API itself.

Individual and business search create and update responses, and schedule responses: added sanctionBodies, the sanction bodies used in the search criteria. Individual searches and schedules also return dobMatching (withinOneYear, sameYear or exact)
Key party create and update responses: added creationMode (import, manual or batchUpload). modifiedById is now documented as an integer, previously a string
POST /compliance/kyc-protect/profiles and PUT /compliance/kyc-protect/profiles/{profileId}: added isKycMonitored
PUT /compliance/kyc-protect/profiles/{profileId}/details: added gender (male or female)
PUT /compliance/kyc-protect/profiles/{profileId}/notes/{noteId} and PUT /compliance/kyc-protect/profiles/{profileId}/attachments/{attachmentId}: added linkedTo (profile or profileDetails)
POST /compliance/kyc-protect/profiles/{profileId}/searches/link and POST /compliance/kyc-protect/profiles/{profileId}/keyparties/searches/link: added message and details to the error of each failed item. For example, an individual search cannot be linked to a business profile, so it is returned in failed with the reason in details
GET /compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}: added supplierHitId to each business and individual link, which is the ID used with the searchLinks endpoints. Added sanctionBodyId to each sanction, and sanctionTypes is now documented as an array, previously a string
POST /compliance/kyc-protect/reports and GET /compliance/kyc-protect/reports/{reportId}: type now includes profile, amlScreen and monitorSearch. Each criteria value can be a string, boolean or array, previously documented as an object
POST /compliance/kyc-protect/profiles/{profileId}/keyparties/searches/link: the success status is now documented as 200, previously 201
GET /compliance/kyc-protect/searches/individuals/{searchId}, GET /compliance/kyc-protect/searches/businesses/{searchId} and GET /compliance/kyc-protect/profiles/{profileId}/schedules/{scheduleId}: added the 404 response, returned when the search or schedule is not found

2026-11-03

(Fix) KYC Protect - Profile Key Party, Search and Hit Fields Added

Added fields that the API already returns to four profile lists. There are no changes to the API itself.

GET /compliance/kyc-protect/profiles/{profileId}/keyparties: added creationMode to each key party (import, manual or batchUpload)
GET /compliance/kyc-protect/profiles/{profileId}/keyparties/searches: added dobMatching to each search (withinOneYear, sameYear or exact)
GET /compliance/kyc-protect/profiles/{profileId}/searches: added sanctionBodies and isDobRequired to each search
GET /compliance/kyc-protect/profiles/{profileId}/hits: added keyPartyId, profileId and scheduleId to each hit. Each can be null

Return All Key Party Records Linked To A Profile endpoint reference
Return All Key Party Searches endpoint reference
Return List Of AML Searches On The Given Profile endpoint reference
Return All Hits Of Searches Linked To A Profile endpoint reference

2026-11-03

(Fix) KYC Protect - Nullable Fields and Correlation Id on Responses

Fields that the API returns as null are now documented as nullable, and correlationId is now documented on the responses that return it. There are no changes to the API itself.

PUT /compliance/kyc-protect/profiles/{profileId}: internalId, assignedToId, assignedTo, safeNumber, companyId, formationDate, kycApprovedAt and kycReviewOn can be null
PUT /compliance/kyc-protect/profiles/assign: internalId, safeNumber, companyId, formationDate, kycApprovedAt and kycReviewOn can be null
PUT /compliance/kyc-protect/profiles/{profileId}/details: tradingName, aliases, activity, description, contactName, email, telephone, turnover, assetsUnderManagement, dateOfBirth, countryCode, vatNo, isListedOnExchange, exchangeName, organizationNumber, internalContact and internalEmail can be null
GET /compliance/kyc-protect/profiles/{profileId}/details/addresses: buildingDetails, region and postalCode can be null
POST /compliance/kyc-protect/profiles/{profileId}/keyparties: failed can be null
supersededHit can be null on GET /compliance/kyc-protect/profiles/{profileId}/hits, GET /compliance/kyc-protect/profiles/{profileId}/amlAlerts, GET /compliance/kyc-protect/schedules/amlAlerts, PUT /compliance/kyc-protect/searches/individuals/{searchId}/hits and the business hit and hit note updates. scheduleId on the AML alerts can also be null
GET /compliance/kyc-protect/searchLinks/individuals/{supplierHitId}: line1 in each address, ownershipPercentage on each business and individual link, and description in each source can be null
GET /compliance/kyc-protect/searchLinks/businesses/{supplierHitId}: amlResults.SOE and ownershipPercentage on each individual link can be null
Added correlationId to the responses of the profile, address, attachment, note, key party, search, hit, schedule, search link, report download and search download endpoints listed below

2026-11-03

(Fix) KYC Protect - Search Deletion and Linking Behaviour

The descriptions of four profile and key party endpoints now explain how the API behaves when searches are deleted or linked. There are no changes to the API itself.

DELETE /compliance/kyc-protect/profiles/{profileId}/searches and DELETE /compliance/kyc-protect/profiles/{profileId}/keyparties/searches: the searches themselves are deleted, not only unlinked from the profile or key party. They can't be retrieved or linked again afterwards
POST /compliance/kyc-protect/profiles/{profileId}/searches/link and POST /compliance/kyc-protect/profiles/{profileId}/keyparties/searches/link: the request returns 200 even when some searches can't be linked. Each one that can't be linked is returned in failed, with the reason in error.details. For example, an individual search can't be added to a company profile, and a deleted search is returned as not found

Delete AML searches linked to a profile endpoint reference
Delete A Batch Of Key Party Searches endpoint reference
Add AML Searches To The Given Profile endpoint reference
Link Searches To Key Parties endpoint reference

2026-11-03

(Fix) KYC Protect - Individual Search Report Download Title

The POST /compliance/kyc-protect/searches/individuals/{searchId}/download endpoint is now titled Download PDF Individual Search Report. It was previously titled Download PDF Business Search Report. There are no changes to the API itself.

Download PDF Individual Search Report endpoint reference

2026-11-03

(Fix) KYC Protect - More Specific Endpoint Titles

Endpoints that shared a title with another endpoint now have their own title, so they can be told apart in lists and search results. There are no changes to the API itself.

GET /compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId} and GET /compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}: Return Full Business AML Search Hit Information By SearchId And HitId, and Return Full Individual AML Search Hit Information By SearchId And HitId, previously both Return Full AML Search Hit Information By SearchId And HitId
GET /compliance/kyc-protect/searches/businesses/{searchId}/hits/{hitId}/download and GET /compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}/download: Download Business AML Details for a Hit, and Download Individual AML Details for a Hit, previously both Download AML Details for a Hit
POST /compliance/kyc-protect/searchLinks/businesses/{supplierHitId}/download and POST /compliance/kyc-protect/searchLinks/individuals/{supplierHitId}/download: Download Business Search Links PDF, and Download Individual Search Links PDF, previously both Download Search Links PDF
GET /compliance/kyc-protect/searchLinks/individuals/{supplierHitId}: Return Individual Links With Supplier Hit Id, previously Return Search Links By Supplier Hit Id, to match the business version
GET /compliance/kyc-protect/authorization/roles/{roleId}/permissions and PUT /compliance/kyc-protect/authorization/roles/{roleId}/permissions: Return Role Permissions By Role Id and Update Role Permissions By Role Id, previously Return Roles Permissions and Update Roles Permissions, the same titles as the endpoints for all roles

2026-11-03

(Fix) KYC Protect - RBAC Batch Update Failures

The failed items returned by the RBAC batch updates are now documented as the API returns them. There are no changes to the API itself.

PUT /compliance/kyc-protect/authorization/roles/permissions and PATCH /compliance/kyc-protect/authorization/roles/permissions: each item in failed now contains the role update that failed (roleId and permissions), previously documented as a user role assignment (userId, roleId and teamId). Its error contains message, details and errors, the validation messages by field name
PUT /compliance/kyc-protect/authorization/users/roles: added message and details to the error of each failed item
Added correlationId to the responses of all three endpoints
All three endpoints return 200 when some items can't be updated, with each one returned in failed. The endpoint descriptions now say so

Update Roles Permissions endpoint reference
Modify Roles Permissions endpoint reference
Update Users Roles endpoint reference

2026-11-03

(Fix) KYC Protect - Search Link and PEP Association Nullable Fields

Fields that the API returns as null for some hits are now documented as nullable. There are no changes to the API itself.

GET /compliance/kyc-protect/searchLinks/individuals/{supplierHitId} and GET /compliance/kyc-protect/searches/individuals/{searchId}/hits/{hitId}: lastName and relationship of each PEP by association entry (PEP.LINKED) can be null
GET /compliance/kyc-protect/searchLinks/individuals/{supplierHitId}: title of each source can be null
GET /compliance/kyc-protect/searchLinks/businesses/{supplierHitId}: line1, line2 and city of each address, and title of each source, can be null

Return Individual Links With Supplier Hit Id endpoint reference
Return Full Individual AML Search Hit Information By SearchId And HitId endpoint reference
Return Business Links With Supplier Hit Id endpoint reference

2026-11-03

(Fix) KYC Protect - Create Profile Response Example

In the POST /compliance/kyc-protect/profiles 201 response example, id and details.profileId now show the same value, as the API returns. Previously the example showed two different values. The details.profileId description now says it is the same value as id. There are no changes to the API itself.

Create Profile endpoint reference

2026-11-02

(Fix) KYC Protect - Report Criteria Response Structure

The GET /compliance/kyc-protect/reports/criteria/{type} response is now documented as a set of criteria keyed by name, matching the response returned by the API. Previously the response documented a single property named additionalProperties, which the API does not return. There are no changes to the API itself.

Each criterion is an object containing isRequired, type, format, description and acceptableValues
The criteria returned depend on the report type. Selectable examples are now included for each report type: amlAlert, audit, profile, amlScreen and monitorSearch

Retrieve Report Criteria endpoint reference

2026-11-02

(Fix) KYC Protect - Key Party Searches Response Structure

The GET /compliance/kyc-protect/profiles/{profileId}/keyparties/searches response is now documented as a list, with the key party searches in an items array and a totalSize, matching the response returned by the API. Previously the response documented the fields of a single search at the top level. The fields of each search are unchanged. There are no changes to the API itself.

Return All Key Party Searches endpoint reference

2026-11-02

(Fix) KYC Protect - Response Fields Aligned with API Responses

Added fields that the API already returns to the KYC Protect response schemas, and corrected the name of the total count on the authorization lists. There are no changes to the API itself.

GET /compliance/kyc-protect/profiles: added isKycMonitored to each profile
GET /compliance/kyc-protect/audits: added teamId to each audit
GET /compliance/kyc-protect/profiles/alerts/metrics: added assignedToId and assignedTo to each profile
Business and individual search hit sources: added id, which is the sourceId used to download a copyrighted source
GET /compliance/kyc-protect/searches: added profileId and profileName, which are returned when the search is linked to a profile
GET /compliance/kyc-protect/authorization/users/{userId}/roles: added createdAt, createdById, createdBy, modifiedAt, modifiedById and modifiedBy to each role assignment
AML preferences, individual searches and individual search details: added dobMatching, the date of birth matching used in the search criteria (withinOneYear, sameYear or exact)
GET /compliance/kyc-protect/authorization/roles/{roleId}/permissions: added correlationId
GET /compliance/kyc-protect/authorization/audits, GET /compliance/kyc-protect/authorization/roles/permissions, GET /compliance/kyc-protect/authorization/users/roles and GET /compliance/kyc-protect/authorization/users/{userId}/roles: the total count is now documented as totalSize, matching the response returned by the API, previously count

2026-11-02

(Fix) KYC Protect - Individual Search Links Response

The GET /compliance/kyc-protect/searchLinks/individuals/{supplierHitId} response now has its own schema, matching the response returned by the API. There are no changes to the API itself.

Added the individual's firstName, middleName, lastName, gender, datesOfBirth, isDeceased, datesOfDeath and pepTier
Aliases now show firstName, middleName and lastName alongside type
AML results now include DD (disqualified directors) and PEP (politically exposed persons)
Removed the business-only fields name, activities, description, businessTypes, the alias name and the SOE AML result, which are not returned for individuals

The GET /compliance/kyc-protect/searchLinks/businesses/{supplierHitId} response is unchanged.

Return Search Links By Supplier Hit Id (Individuals) endpoint reference

2026-11-02

(Fix) KYC Protect - Required Paging Parameters

The page and pageSize query parameters are now documented as required on GET /compliance/kyc-protect/authorization/audits and GET /compliance/kyc-protect/authorization/users/{userId}/roles, matching the API, which returns 400 when either is missing. page must be 1 or more, and pageSize must be between 1 and 100. They were previously documented as optional. There are no changes to the API itself.

Return Audits endpoint reference
Return Users Roles By User Id endpoint reference

2026-11-02

(Fix) KYC Protect - Download Monitored Searches Responses

The GET /compliance/kyc-protect/searches/monitored/download endpoint now documents all of its responses. There are no changes to the API itself.

Added the 204 No Content response, returned with no body when no monitored searches match the criteria
Added the 409 Conflict response, returned when more than 1,000 monitored searches match the criteria
Corrected the endpoint description, which now explains when each of these responses is returned

Download A CSV Report Of Monitored Searches endpoint reference

2026-10-23

(Fix) KYC Protect - Response Schemas Aligned with API Responses

Corrected the KYC Protect OpenAPI specification so that response schemas match the responses returned by the API. There are no changes to the API itself.

Added correlationId to the responses of 30 endpoints, including profiles, addresses, attachments, key parties, business and individual searches and hits, search links, schedules, batch uploads, alerts and role-based access control
Fields that can be returned as null are now documented as nullable, including internalId, safeNumber, companyId, formationDate, kycApprovedAt and kycReviewOn on profiles, modifiedAt and modifiedBy on profile addresses, note, pepTier and supersededHit on search hits, and SOE on business hit AML results
Individual search hits: profileImages is now documented as an array of image URLs, previously a string
Individual search hit sources: isCopyrighted is now documented as a boolean, previously a string

Return Created Profiles endpoint reference
Return Lists Of Addresses endpoint reference
Return Individual AML Search Hits endpoint reference
Return Full AML Search Hit Information (Individuals) endpoint reference
Return Full AML Search Hit Information (Businesses) endpoint reference

2026-10-23

(Fix) KYC Protect - Look Up Permissions and Roles Response Structure

The GET /compliance/kyc-protect/authorization/lookUp/permissions and GET /compliance/kyc-protect/authorization/lookUp/roles responses are now documented as an object containing a data array and a correlationId, matching the response returned by the API. They were previously documented as a top-level array. The permission and role objects inside data are unchanged. There are no changes to the API itself.

Return LookUp Permissions endpoint reference
Return LookUp Roles endpoint reference
Role-Based Access Control guide

2026-10-20

(Update) All Connect APIs - Open-Ended Objects

Objects whose properties vary, for example by country or data provider, are now explicitly documented as allowing any number of properties using additionalProperties: true, with a description explaining that the properties can vary. Previously these objects were shown as empty. This improves compatibility with code generators, which can now keep all returned or submitted properties. There are no changes to the API itself.

Covers Access, Bank Match, Check & Decide, Consumer & Miscellaneous, Credit & Risk, Data Cleaning, Global Monitoring, KYC Protect, Local Solutions and Protect
Credit & Risk: the directorsExtra, extendedGroupStructureExtra, paymentDataExtra and negativeInformationExtra sections of the company report now explain that their properties depend on the data provider used for the country of the company being reported on

Company Credit Report endpoint reference

2026-10-20

(Fix) Check & Decide - Update Instance Configuration Request Example

The request example for PUT /decisionEngine/instance/{guid} is now shown on the request body, and the orderIndex property name in the example has been corrected, previously orderInde. There are no changes to the API itself.

2026-10-20

(Fix) Credit & Risk - Data Dictionary Links

Updated the links to the Connect API data dictionaries in the company report schema so they point to the data dictionaries page in the developer portal, replacing the previous support site article. This affects the descriptions of local financial statements, additional information, negative information and payment data.

Connect API Data Dictionaries

2026-10-19

(Update) Credit & Risk - Company Search Response Examples

The Company Search 200 response is now documented as a single schema, with two selectable examples: Results found and No results. A search that matches no companies returns 200 with a totalSize of 0, an empty companies array and a NoResults message. Descriptions have also been added to the dateOfLatestAccounts, dateOfLatestChange, phoneNumbers and activityCode properties. There are no changes to the API itself.

Company Search endpoint reference

2026-10-19

(Update) Credit & Risk - Confidence Match Search Response

The Confidence Match Search 200 response is now documented as a single schema, with two selectable examples: Match found and No match. A request that finds no matches returns 200 with a totalMatches of 0 and an empty matchedCompanies array. Fields that the API already returns have been added to the response schema. These are additions only, and there are no changes to the API itself.

Added correlationId
Added vatNo to each matched company
Added houseNo and province to the matched company address
Added matchScoreProvince to matchScoreExplainPlan
Corrected the documented property name matchScoreLocal Id to matchScoreLocalId

Confidence Match Search endpoint reference

2026-10-19

(Fix) Credit & Risk - Missing Schema Types

Added missing type definitions to the OpenAPI specification to improve compatibility with code generators and validation tools. There are no changes to the API itself.

Fresh Investigations: PATCH /freshinvestigations/{orderId} 200 response
Confidence Match Search: 200 response
Company Report: officeType in the company basic information

2026-10-19

(Fix) Credit & Risk - Companies Guide Status Codes

Corrected the Companies guide to show that a company search with no matching companies returns 200 with a totalSize of 0, not 404. A 404 is only returned when the requested resource does not exist, such as an unknown connectId or report schema.

Companies Guide

2026-10-19

(Fix) Global Monitoring - Date Field Format

Date fields in Global Monitoring responses are returned in ISO 8601 format without a time zone offset, for example 2022-01-20T12:45:43. The OpenAPI specification previously documented these fields as date-time, which requires a time zone offset. The date-time format has been removed and the descriptions updated so that the specification matches the response returned by the API. There are no changes to the API itself.

User Details: createdDate, lastAccessDate, modifiedDate and contractEndDate
Companies in a portfolio: dateLastEvent, dateAdded and dateModified
Company Events and Notification Events: eventDate and createdDate

2026-10-19

(Fix) Global Monitoring - Response Schema Corrections

Corrected the OpenAPI specification so that response fields match the values returned by the API. There are no changes to the API itself.

List Portfolios: isDefault is now documented as a boolean, previously a string
Event Rules and Portfolio Event Rules: isActive is now documented as an integer, where 0 is inactive and 1 is active, previously a boolean
Portfolio Event Rules: param2 is now documented as a string, previously a boolean
Import and Sync a Portfolio File: the response field is now documented as message, previously status
User Details: added homeUrl
Companies in a portfolio: added descriptions and examples for dateAdded and dateModified
Added missing type definitions to several response and request schemas to improve compatibility with code generators and validation tools

List Portfolio Event Rules endpoint reference
Import a Portfolio File endpoint reference

2026-10-19

(Fix) Global Monitoring - Request Examples

Corrected request examples so they match the request schema accepted by the API.

Import and Sync a Portfolio File: the file field in the example is now importcsv, previously importCsv
Update Event Rules: the rule 101 example now sends param2 as the string "true", as described in the Special Event Rules guide

Update Event Rules endpoint reference
Special Event Rules guide

2026-10-07

(Fix) Bank Match - IBAN and BBAN Company Guides

Corrected the IBAN and BBAN company guides so they match the API specification. There are no changes to the API itself.

Fixed broken links to the endpoint reference pages
Corrected the company search examples to use GET with query parameters instead of POST
Added parameter tables for the IBAN and BBAN company search endpoints
Added guidance on reviewing search results, including the response fields and the difference between 200 Success and 202 Accepted
Added the IBAN company search history endpoint to the IBAN company guide

IBAN Company Guide
BBAN Company Guide

2026-10-07

(Add) Bank Match - IBAN Person Guide

A new guide is now available for the IBAN person endpoints, covering search criteria, person search, reviewing results and search history.

IBAN Person Guide

2026-10-01

(Update) Credit & Risk - Sweden UBO Location in the Company Report

Updated the documented location of Ultimate Beneficial Owner (UBO) data for Sweden (SE) in the company report to $report.shareCapitalStructureExtra.beneficialOwners[*], replacing the previously documented $report.shareCapitalStructure.beneficialOwners[*]. UBO data is an additionally charged item and is only returned when your account has access to the relevant template; otherwise the beneficialOwners object is omitted from the response.

Where to find UBO data in the company report

2026-10-01

(Update) All Connect APIs - Error Responses Added to OpenAPI Specifications

Added error responses to the OpenAPI specifications across Connect APIs so they match the error behaviour already described in the documentation. These are additions only and there are no breaking changes to existing requests or responses.

Added a 500 Internal Server Error response to endpoints across all products
Added missing 4xx responses, such as 400, 401, 403 and 404, where they were not previously documented
Covers Access, Bank Match, Check & Decide, Consumer & Miscellaneous, Country Risk, Credit & Risk, Data Cleaning, Global Monitoring, KYC Protect, Local Solutions, Prospects and Protect

Connect API error codes and status reference

2026-09-03

(Fix) Credit & Risk - Company Search No Results Response Schema

Corrected the documented 200 no results response for Company Search so that companies and messages are shown as arrays, matching the response returned by the API server.

Company Search endpoint reference

2026-08-27

(Add) KYC Protect - Role-Based Access Control (RBAC) APIs

New Role-Based Access Control (RBAC) APIs are now available, enabling organisations to centrally manage user access, permissions, and governance across KYC Protect, including Profiles, Screening, Monitoring, Alerts, and administrative functions.

Retrieve available roles and permissions
Assign and remove roles for users
Configure the permissions associated with a role
Determine the permissions available to the currently authenticated user
Access audit records for role and permission management activity

RBAC APIs Overview
RBAC Endpoints

2026-08-27

(Add) KYC Protect - Search Hit Change History Endpoints

New endpoints are now available to retrieve the change history for an individual hit within a business or individual AML search.

Business Search Hit Changes
Individual Search Hit Changes

2026-08-27

(Add) Bank Match - IBAN Match History Endpoints

New endpoints are now available to retrieve IBAN match history for companies and people.

Company IBAN History
Person IBAN History

2026-08-27

(Add) Check & Decide - Decision History Export

A new endpoint is now available to export decision history from the Decision Engine.

Decision History Export

2026-08-20

(Update) Information - New Data Dictionaries Posted

New Data Dictionaries for the following markets:

Faroe Islands
Israel

Data Dictionaries

2026-08-20

(Add) Sweden APIs - New Product Release

The Sweden APIs are now available, providing localised company and consumer data services for the Swedish market. These are Country APIs specific to Sweden rather than Connect APIs.

Products Released:

Date Check
Get Data
Get Data Unit
Get Signatory
Search Engine
SPAR Consumer Search

Country APIs Catalog

2026-08-17

(Fix) KYC Protect - Basic Integration Workflow Corrected Request/Response Examples

Corrected inaccurate request and response examples throughout the Basic Integration Workflow documentation, identified via customer feedback on profile creation and KYC monitoring enrolment, and aligned the companion machine-readable Arazzo specification to match.

Key Fixes:

Profile creation: individual profiles now correctly show the required details.legalName field (previously showed non-existent firstName/lastName fields, causing validation errors)
KYC monitoring enrolment: corrected request body from profileIds to items (previously caused validation errors)
AML monitoring schedules: replaced fabricated request fields (profileId, searchIds, email, frequency) with the correct items[] schedule structure
Corrected response examples for AML search hits and KYC alerts to match actual API field names
Standardised alert status values to open / closedProcessed / closedUnprocessed
Updated the Arazzo workflow specification with matching payload corrections, including several operationId values that did not resolve against the OpenAPI source

Basic Integration Workflow

2026-07-23

(Add) Prospects - New Product Now Available

The Prospects API is now available, providing a comprehensive solution for creating and exporting prospect orders for business development and marketing purposes.

Key Features:

Complete order lifecycle management (preview, create, get details, export)
Multiple export formats (CSV, JSON, XML)
202 Accepted polling pattern for long-running export operations
Machine-readable Arazzo 1.0.1 workflow specifications for integration automation

Prospects API Documentation

2026-07-23

(Update) Credit & Risk - Company Search and Report Workflow Documentation Enhanced

Enhanced the company search and report workflow documentation with comprehensive integration guidance, real API response examples, and improved accessibility compliance.

Key Improvements:

Added sequence diagrams showing success and failure paths for all workflow steps
Updated example responses to match actual API behaviour
Enhanced error handling documentation with retry guidelines
Improved multi-country search criteria behaviour documentation
Accessibility-compliant with WCAG 2.2 AA / EAA standards

Company Search and Report Workflow

2026-07-23

(Add) Credit & Risk - Additional Search and Report Options Documentation

Added new documentation covering optional endpoints that complement the core company search and report workflow, including report schemas and available report languages.

Additional Search and Report Options

2026-07-23

(Add) MCP Documentation - Model Context Protocol Integration Guide

Added comprehensive documentation for using the Creditsafe Model Context Protocol (MCP) server with AI-powered IDEs, enabling LLMs to discover and integrate with Creditsafe APIs automatically.

Key Features:

Installation instructions for VS Code and Cursor
Six usage examples including KYC integration code generation
Workflow intelligence for automatic discovery of integration patterns
Available MCP tools reference

Model Context Protocol Documentation

2026-07-17

(Update) Information - Data Dictionaries Updated

Updated Data Dictionaries for the following markets:

Australia ACN
Cyprus
New Zealand

Data Dictionaries

2026-07-17

(Add) KYC Protect - Workflow Documentation and Machine-Readable Specifications

Added comprehensive workflow documentation with machine-readable Arazzo specifications for KYC Protect integration paths:

Basic Integration Workflow - Complete 10-step integration covering profile management, AML screening, hit decisions, and monitoring setup for both business and individual entities
Business AML Search Workflow - Focused 4-step workflow for business entity AML screening
Individual AML Search Workflow - Focused 4-step workflow for individual person AML screening

Key Features:

Step-by-step integration guides with request/response examples
Comprehensive error handling documentation for all workflow steps
Mermaid flowchart and sequence diagrams for visual workflow understanding
Machine-readable Arazzo 1.0.1 workflow specifications for test automation and LLM integration
Bidirectional linking between human-readable documentation and machine-readable workflows
Accessibility-compliant documentation (WCAG 2.2 AA / EAA)

Basic Integration Workflow
Business AML Search Workflow
Individual AML Search Workflow

2026-07-17

(Fix) Credit & Risk - Company Report Documentation Example URL

Corrected the example URL in the Company Report documentation to use the correct parameter format for the countries query parameter.

Company Report Documentation

2026-06-29

(Add) US Consumer Reports Now Available

US Consumer Reports are now available through the Consumer & Misc endpoints. These reports provide comprehensive consumer credit information including credit scores, trade lines, and negative information for individuals in the United States.

Key Features:

Two report templates: Basic (view-only) and HardCheck (leaves inquiry footprint)
Comprehensive credit history and trade line information
Support for current and previous address history
Full data dictionary available for field reference

US Consumer Reports Documentation

2026-06-16

(Update) Information - Data Dictionaries Updated

Updated Data Dictionaries for the following markets:

Chile
Germany
Norway
Poland
United Kingdom
USA

Data Dictionaries

2026-05-21

(Add) New Verify POST Method for Individual Search

A new POST method has been added to the Verify endpoint, enabling individual searches with the ability to include previous addresses in the request. This enhancement improves the flexibility and accuracy of individual verification processes.

Verify Individual Search POST Method

2026-05-08

(Update) UBO Information Table in Company Report Updated

The UBO data table has been updated to include the UK and the location of the data in the company report. Update to the status of German UBO data.

UBO Information Page

2026-05-08

(Update) Response models for Country property

The response models that contain the property Country have been updated to include a broader context to prevent code-generation issues. Enum response for this property has been removed and updated to this:

country:
  type: string
  pattern: '^[A-Z]{2}$'
  description: ISO 3166-1 alpha-2 country code representing the geographic location of the entity.
  example: MC

Company Report Endpoint

2026-04-29

(Add) Country Risk - Product Release in API Catalog

Released the Country Risk product documentation in the API Catalog, including endpoint reference and supporting guidance for country-level compliance risk data.

Country Risk product page

2026-04-29

(Update) Information - Data Dictionaries Coverage Expanded

Updated the Data Dictionaries page to include additional market coverage and improve regional reference content.

Added Denmark to the Europe section
Added South Korea to the Asia-Pacific section
Added a new regional entry for Europe & Central Asia (Selected Markets), including the aligned market list and supporting note

Data Dictionaries page

2026-04-21

(Add) Information - Data Dictionaries

Added a new Data Dictionaries page to the documentation portal, providing direct download links to available country and region-specific data dictionary PDF files.

Dictionaries are organised by region for easier navigation: Common, Regional, Asia-Pacific, Europe, Americas, and Africa
Countries with multiple dictionary variants, such as Australia (ABN / ACN), China (PLC / Non-PLC), Germany (Ltd / Non-Ltd), Norway (Ltd / Non-Ltd / Director Report), and Sweden (Ltd / Non-Ltd), are listed together under a single entry
PDF files are served directly from the portal and available to download

See details

2026-04-20

(Fix) KYC Protect - AML Schedule Response Documentation Update

Updated KYC Protect AML schedule response documentation to better reflect the response structure returned by the API and improve clarity for integrators.

Refined response schema field definitions and descriptions for AML schedule hit data
Improved nullable field representation for clearer consumer implementation
Simplified selected optional response fields for more consistent usage patterns
Updated nullable values across multiple related schemas to improve consistency in documented request and response structures

See details

2026-04-08

(Add) KYC Protect - New Hit Notes and Searches Endpoints

Added four new endpoints to KYC Protect to support hit note updates and reviewing completed searches:

Added hit note update endpoints:
- Update note for a business hit
- Update note for an individual hit
Added searches endpoints to review performed searches and download monitored search reports:
- Return performed searches
- Download monitored searches

2026-04-08

(Update) KYC Protect - Parameter and Description Corrections

Applied documentation and schema corrections across KYC Protect endpoints:

Updated keyPartyTypes to an array of strings for Return all keyparty by profile id.
Corrected endpoint description wording for Return profile attachment by profile id and attachment id.
Updated hitDecisions to an array of strings for:
- Return Business AML Search hits by search id
- Return Individual AML Search hits
Added fromDate and toDate query parameters to Return all hits for a schedule by created date.
Added assignedToId query parameter (integer, int32) to Return profile alerts metrics.

2026-04-07

(Update) Reviewed API Updates - KYCProtect

Applied 1 reviewed change(s): Parameters updated for GET /compliance/kyc-protect/profiles — Selective add (2 parameter(s)). Changed parameter(s): statuses (query, added), pageSize (query, updated).. See details

2026-04-07

(Fix) Schema Updates - KYCProtect

Updated 1 schema(s): POST /compliance/kyc-protect/profiles/businesses/import. callRef parameter default value changed to null in documentation See details

2026-03-27

(Update) Portal-Wide Accessibility Improvements (WCAG 2.2 / EAA Compliance)

Completed a comprehensive accessibility review and remediation pass across the documentation portal to align with WCAG 2.2 AA and the European Accessibility Act (EAA) requirements. Changes affect all public-facing product and information pages.

Key improvements made:

Added plain-text diagram summaries beneath all Mermaid process flow diagrams to provide screen-reader-accessible alternatives (affects Global Monitoring, Bank Match, Check & Decide, Consumer & Misc, Credit & Risk, Data Cleaning, KYC Protect, Local Solutions, and Data Studio documentation)
Replaced non-keyboard-accessible lightbox images with natively focusable full-size image links throughout the portal
Verified and confirmed existing prefers-reduced-motion support in the changelog notification widget

2026-03-27

(Update) Quick Start Guide - Revised for Clarity and Usability

Rewrote and restructured the Quick Start guide to be more direct and actionable for new API users. Changes include:

Condensed and clarified all three steps (Download, Authenticate, Send Your First Request) with more precise instructional language
Replaced purely decorative screenshot images with keyboard-accessible "View full-size image" links alongside each screenshot, ensuring all users can access the visual content
Removed redundant guidance and tightened the prose throughout to reduce cognitive load for first-time users

2026-03-17

(Add) KYC Protect - New Download Endpoints for Supplier Hit IDs

Added new endpoints to support downloading search links by supplier hit ID for both business and individual AML screening:

2026-03-17

(Add) Global Monitoring - Notification Events by Day Endpoint

Introduced a new endpoint to retrieve notification event data by day for a specific portfolio in Global Monitoring:

Portfolio Notification Events by Day

2026-03-17

(Add) Global Monitoring - Company Status Property Documentation

Added a dedicated documentation page for the companyStatus property, clarifying value meanings and regional differences.

Company Status Property documentation

2026-03-17

(Update) Global Monitoring - Company Status Property Descriptions

Updated property descriptions for companyStatus in the API reference for both List Companies in a Portfolio and Get Company Details from a Portfolio to clarify value meanings and regional differences.

2026-03-17

(Update) Global Monitoring - isProcessed Property Documentation

Updated the documentation for the isProcessed property in event notifications to clarify its purpose and usage.

2026-02-12

(Add) Credit & Risk - Country Code Schema - Monaco (MC) Support

Added MC (Monaco) to the countryCode enum list in the CreditsafeGlobalDataCountryCode schema, expanding country coverage for Credit & Risk API operations.

2026-02-04

(Update) KYC Protect - Individual AML Search Dataset Descriptions

Updated the documentation for the Individual AML Search endpoint to clarify and expand the descriptions of available datasets. This change improves transparency on dataset options and their usage for AML screening of individuals.

See details

2026-01-29

(Add) Site Footer with Key Links

Added a new footer to the site containing key links relevant to Creditsafe documentation and services, improving navigation and access to important resources.

2026-01-29

(Add) Compliance Alerts Endpoint and Documentation

Introduced a new API endpoint for Compliance Alerts, enabling pre-qualification screening of companies, directors, and UBOs for sanctions and enforcement matches. This service is designed to enhance compliance workflows and risk management.

2026-01-29

(Add) Changelog Notification Widget

Implemented a new client-side changelog notification widget to alert users of documentation changes since their last visit. No user data is stored; all tracking is local to the browser.

Learn more about the changelog widget

2026-01-14

(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

2026-01-14

(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

2026-01-14

(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

2026-01-14

(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

2025-12-17

(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

2025-12-04

(Add) Schema Updates - KYCProtect

Updated 1 schema(s): KycProtectPostProfilesRequest. Addition of Nullable values to the properties.

Endpoints: /compliance/kyc-protect/profiles

See details

2025-12-04

(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 miscellaneous object and the fcaData array within the additionalInformation property.
Property descriptions and example response snippets are provided, along with notes on possible values for fcaAuthorisationStatus.
FCA Data Documentation

2025-11-28

(Update) Credit & Risk - UK IDV Product Documentation

Added a dedicated documentation page for the UK IDV product’s additionalData field, including property descriptions and guidance on handling country-specific response structures.
See details: UK IDV Additional Data Documentation

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

2025-11-17

(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 behaviour:
- 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:

POST Add Search To AML Monitoring
Add Search To AML Monitoring
POST Request Multiple searches linked to a key party asynchronously
Request Multiple searches linked to a key party asynchronously
POST Perform bulk AML screening
Perform bulk AML screening
POST Return Individual AML searches
Return Individual AML searches
POST Business Search in KYC
Business Search in KYC
PUT Update Schedules
Update Schedules
PUT Update a Schedule in Monitoring
Update a Schedule in Monitoring

Responses:

GET Return All Ordered Schedules
Return All Ordered Schedules
GET Return all schedules by profile id and modified date
Return all schedules by profile id and modified date
GET Return Business AML Search by Search Id
Return Business AML Search by Search Id
GET Return Schedule by ProfileId and Schedule ID
Return Schedule by ProfileId and Schedule ID
GET Return Individual AML searches
Return Individual AML searches
GET Return individual AML search by search ID
Return individual AML search by search ID
GET Return all keyparty searches
Return all keyparty searches
GET Return Async Job criteria by id
Return Async Job criteria by id
GET Business Search in KYC
Business Search in KYC

2025-11-05

(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

2025-11-05

(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

2025-11-05

(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:

Event Rules in a Portfolio (Global)
Event Rules in a Portfolio by Country
This change clarifies the expected data type for param2 in the provided example requests and responses.

2025-10-13

2025-11-05

(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:

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.

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

(Remove) Link to Legacy API Documentation in the Nav bar has been removed.

No description provided

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-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-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