Following a successful application for Registry API access, you will be issued with a unique API Key.
Test Environment
In the Test Environment, your API Key will have access to all available API services, allowing you to develop, integrate, and complete the required testing activities.
Production Environment
In the Production Environment, API Keys are granted Level 1 (read-only) access by default. This includes the following services:
GetEntityInformation
CheckSubmissionStatus
CheckName
GetCountries
To obtain Level 2 access and submit data to the Registry, you must successfully complete the prescribed testing process. During the application and testing process, you can select the services you require access to and will only be assessed against those services.
Service-Level Permissions
API Keys are assigned permissions at a granular level, enabling access to be granted or restricted for individual services.
The following permissions can be assigned to an API Key:
CheckName
CheckSubmissionStatus
GetEntityInformation
AmendAssociatedParty
AmendShareCapital
ChangeRegisteredOffice
FileConfirmationStatement
UploadAttachment
GetCountries
The GetCountries service is enabled by default for all API Keys.
