Planned changes to Disclose Register APIs

Last updated 14 April 2025

The Disclose Register will be replaced by a more modern platform in early 2026. The new register will improve performance issues, enable processing efficiencies, and improve the quality of data.

A new API will be produced to replace the current DiscloseCompliance and DisclosePublic API’s. Users of these services will need to make changes for their products to work with the replacement API, which will be significantly different in design to the old APIs though will still provide the same data from the register.

Key API changes

• There will be a single REST API to replace all the functionality of the DisclosePublic and DiscloseCompliance SOAP APIs.

• The REST API will provide all the same data as before but the data will be in JSON format in a completely different structure to the current XML content. Documents will be provided to detail the change from XML fields to the corresponding JSON fields.

• HATEOAS principles will be used, meaning that certain types of data or documents for offers, schemes, and funds will be retrieved via links to API sub-resources. These sub-resources allow retrieval of data in a paginated form. For example, instead of returning all data in a single response, the operation for getting an offer details will return core information about the offer and links to the offer's funds, filing history, issuers, various types of documents, and other types of data that may have large numbers of items. This provides better flexibility for API users to retrieve only specific types of data on-demand when needed or use automation to retrieve all data if required.

• API performance is a key target of the replacement register, addressing the slow response times for retrieving data or submitting compliance for large offers and funds.

• No operation for submitting new funds will be provided due to lack of demand and complexity of the service. Offers, schemes, and funds all need to be created in the online register, though fund compliance can still be performed through the new API.

Disclose Register replacement indicative timeline

This page will be updated with more details of the replacement Disclose API as we move through development and testing. The new API will be made available to customers in the sandbox test environment in October 2025 once sufficient internal testing has been completed. It is possible that some API operations may be made available earlier.

API design

Further information about the API design will be added here as the details are finalised, including data dictionary documents that describe the data model and the mapping of previous XML elements to new JSON content.

Authentication and authorisation

The API will use the same method as existing DisclosePublic and DiscloseCompliance APIs, with a subscription key and optional OAuth2 bearer token as described here.

Existing API users will need to resubscribe to the new API.

The login used to subscribe to the API must be the same RealMe login as used on the Disclose Register itself.

As users may be part of multiple organisations in the Disclose Register, all API requests must contain an x-organisation-key header to ensure that the API interaction is authorised at the required organisation permissions. The organisation key can be found by logging into the new Disclose register and viewing the organisation settings page.

API operations

The API will have the high-level API operations as described in the table below. Details of all API sub-resources and field structures will be published as designs are finalised, followed by the final design in OpenAPI specification format. The details will include a description of how old SOAP API XML elements are mapped to the replacement JSON API content.