Last updated 14 October 2025
The Disclose Register will be replaced by a modernised platform in March 2026. The new register will enable processing efficiencies, improve the quality of data, and improve system performance, supported by a new API for interacting with the register.
The DiscloseCompliance and DisclosePublic APIs will be retired when the new register is launched. Users of these services need to update their products to work with the replacement API, which provides the same data from the register but has a significantly different design to the old SOAP APIs.
A sandbox test environment is now available for development and testing.
New Disclose Register API
Key API changes
A single REST API will replace all the functionality of the DisclosePublic and DiscloseCompliance SOAP APIs.
The new 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.
HATEOAS principles will be used, meaning that certain types of data or documents for offers, schemes, and funds may be retrieved via links to API sub-resources in a paginated form. This provides better flexibility for API users to retrieve only specific types of data on-demand when needed.
The main operations for getting offer, scheme and fund details do not include filing history, and fund information is not returned in the get offer response. The responses will provide links to other API operations to retrieve the filing and fund information. The main response will only include the first 10 items in any arrays of object data, such as participant details or document lists. The response provides links to API operations that can be used to retrieve all items of data.
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.
The API will use ETags to enable efficient retrieval of data, optionally allowing API consumers to retrieve detailed data only if it has been updated since the last time they requested the same information.
API responses will include a URL to view the corresponding information on the Disclose online register.
API design
Draft API specification
The Disclose API specification can be viewed in our developer portal here. You can also download the definition for viewing in Swagger Editor, SwaggerHub, or other tools. The specification is not yet finalised and may have minor changes as Disclose Register development and testing is completed.
Authentication and authorisation
The API will use the same authentication 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. Users will be able to access a Disclose Register test environment to set up an organisation key when the API is ready for testing.
ETags
The API uses ETags to enable efficient retrieval of data, optionally allowing API consumers to retrieve detailed data only if it has been updated since the last time they requested the same information. It is recommended that API consumers use this process to avoid unnecessary processing of data.
Many of the API operations return an ETag header that can be stored by API consumers and sent in the If-None-Match header the next time the API operation is called for the same item. The ETag associated with the entity is changed whenever the item is updated.
The API will return the full requested data when the If-None-Match header is omitted from a request or if the ETag provided in the header does not match the current ETag for the item. If the information has not been updated then the provided ETag will still match the current ETag and the API will send an empty status 304 Not Modified response to indicate that the consumer already has the current data and does not need to retrieve it again.
The API supports the following headers for conditional requests:
If-none-match
Return success if the item has been changed since the version associated with the supplied ETag value. Return 304 Not Modifiedif the item has not changed.
If-match
Return success if the item has not changed since the version associated with the supplied ETag value. Return 412 Precondition Failed if the item has changed.
If-Modified-Since
Return success if the item has been changed since a specified date. Return 304 Not Modifiedif the item has not changed.
If-Unmodified-Since
Return success if the item has not changed since a specified date. Return 412 Precondition Failed if the item has changed.
API operations
The API has the high-level API operations described in the table below, with supporting documentation to supplement the API specification. The documentation outlines the API data fields and includes a mapping between the JSON field names, their counterparts in the existing SOAP XML schemas, and the new Disclose Register web interface.
Offers
Heading
Method
Operation
Details
Documentation
GET
/offers
Search offers using a range of criteria and receive a paginated list with summary information for matching results.
GET
/offer/{offer-number}
Get details of an offer. Historic versions of the offer can be returned.
GET
/new-or-changed-offers
Retrieve a paginated list of new or changed offers within the supplied date range parameter (startDate, endDate inclusive) provided in the request.
Schemes
Method
Operation
Description
Documentation
GET
/schemes
Search schemes using a range of criteria and receive a paginated list with summary information for matching results.
GET
/scheme/{scheme-number}
Get details of a scheme. Historic versions of the scheme can be returned.
GET
/new-or-changed-schemes
Retrieve a paginated list of new or changed schemes within the supplied date range parameter (startDate, endDate inclusive) provided in the request.
Funds
GET
/fund/{fund-number}
/offer/{offer-number}/funds
Get details of a fund. Historic fund data can be returned for a specified version of the parent offer.
PUT
/offer{offer-number}/fund/{fund-number}/submit-fph-compliance
Allows users with relationship and/or appropriate permission to update an existing fund full portfolio holdings for compliance.
PUT
/offer/{offer-number}/fund/{fund-number}/submit-fund-compliance
Allows user with relationship and/or appropriate permission to update an existing fund for compliance.
Activities
GET
/activities
Allows users to retrieve details of upcoming compliance activities due for funds they have authority over.
Documents
GET
/offer/{offer-number}/{document type}/{documentRecId}
/scheme/{scheme-number}/{document type}/{documentRecId}
/fund/{fund-number}/fund-update-document
Returns a 302 redirect to a signed URL for downloading the document specified in the documentRecId parameter.
documentRecId values are returned in response content for offers and schemes, and their sub-resources.
Sandbox test API
A sandbox test version of the API is now available. To use this, you will need to subscribe to the API and set up an organisation in the Disclose Register sandbox environment.
API user set up
Subscribe to the API
Log in to the API developer portal and subscribe to the Disclose Register API Product. If you are a new API user our API support team may request further information before the subscription can be approved.
The subscription will request access to sandbox and production environments, the production request will remain pending until that environment is available in March 2026.
Set up a Disclose Register user profile and organisation
To use the API you must also be a member of an organisation in the Disclose Register and provide the organisation ID in your API calls. You can log in to the Disclose Register sandbox environment here.
The Disclose Register organisation set up guide provides instructions on how to create an organisation and retrieve the ID needed in the API.
Generate an API subscription key and call the API
For full details on how to generate an API subscription key, and optionally an OAuth2 bearer token for additional security, please see here.
Once your sandbox subscription has been approved by our support team you will be able use your API credentials to call the API. Use the sandbox key and sandbox endpoints in your software development.
Release notes
The API is undergoing final revisions as development and testing of the new register continues, there will be minor adjustments in behaviour as updates are released. Significant known issues and limitations are listed here.
14 October 2025 - first public test environment release.
/new-or-changed-offers and /new-or-changed-schemes operations are not available and will return 404 errors. These will be usable after 22 October.
Functionality related to overseas offers is incomplete and not expected to be fully available until after 5 November.
Sandbox data
The sandbox environment is populated with automatically generated test cases and is not a copy of data from production or legacy Disclose Register test environments.
