Disclose Register API

The Disclose Register API provides a link between your business systems and the Disclose register. You can retrieve public information of offers of financial products and managed investment schemes. Fund managers can identify compliance activities, submit compliance data, and verify that compliance activities have been completed on the Disclose Register.

Using the API

Follow these steps to get up and running:

Read the technical details

View the API definition in our developer portal here. You can also download the definition for viewing in Swagger Editor, SwaggerHub, or other tools.

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.

The Disclose Register organisation set up guide provides instructions on how to create an organisation and retrieve the ID needed in the API.

To test the Disclose Register API you can log in to the Disclose Register sandbox environment here and set up an organisation in the Disclose Register sandbox environment.

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.

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 login used to subscribe to the API must be the same RealMe login as used on the Disclose Register itself.

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.

API design

• HATEOAS principles are 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.

• There is 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.

• API responses will include a URL to view the corresponding information on the Disclose online register.

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.

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:

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 historic SOAP XML schemas, and the new Disclose Register web interface. The Disclose Register API definition prevails in the case of any inconsistency in the following documents published below 9 December 2025 during the Disclose register replacement project.

Version history

Release notes

Refer to the Disclose API release notes for detailed information about updates to the service.