This is NOT applicable for Web Portal users.
A REST API workshop was held in January 2025. Links to the Workshop recording can be found here, FAQ and the Presentation from the workshop can be found here
Quick links
To start using the REST API in the live production environment, your Organisation must complete the following four steps
- Developer Portal Registration Form
- TEST REST API Credentials Form
- REST API Sign Off Pack
- Production REST API Credentials Form
Â
For any technical issue please use the below forms
- Test/Integration API Contact us forms for Technical Issues
- Production API Contact us forms for Technical Issues
Â
To support Developers we have a dedicated Developer Portal to support this change, we are launching a Developer Portal where API developers can view and download information needed to integrate their system with the Claims Portal API interface.Â
This Developer Portal will contain publicly available information which can be accessed by all, including:Â
- High level information regarding the Claims Portal APIÂ
- Useful documents including workflows and documents relating to notificationsÂ
- Guidelines to be followed for the integrationÂ
- Details of support available to users.Â
In addition to the Developers Portal, there will be a password-protected private section, available only to developers who are verified registered users, who need access. This area will contain:
Documentation, including detailed information regarding the relevant API and a downloadable Software Development Kit (SDK) Â
Reference details, including the API swagger and for each method examples and the JSON schemas.Â
You will need to be registered on the Developer Portal using the above form before this request can be processed
Once your credentials have been set up, we will then be in touch to provide instructions for the use of the Developer Portal.
Any developers requiring access this secure area should register using the form below.
Â
Request REST API Integration/ Test Credentials
Completing the REST API Credentials form below will allow you to obtain your client_id and client_secret for the Claims Portal Integration/Test REST API interface.
You will need to be registered on the Developer Portal using the above form before this request can be processed
