REST API Developers
This information is intended for organisations using the A2A SOAP to connect to their systems.
This is NOT applicable for Web Portal users.
We will dual run the existing SOAP and upgraded REST interfaces at least until the end of January 2026. This period gives users the flexibility to develop the new REST integrations whilst continuing to use the SOAP interface.
Links to the REST API Workshop recording can be found here, FAQ and the Presentation from the workshop can be found here
Quick links
There are 6 steps and 4 forms to complete, to make your Organisation ready to migrate from SOAP to REST
- Developer Portal Registration Form
- TEST REST API Credentials Form
- REST API Sign Off Pack
- Production REST API Credentials Form
- Test/Integration API Contact us forms for Technical Issues
- Production API Contact us forms for Technical Issues
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
Please note that the sign off process can take up to 10 business days and can take longer during peak periods.
Prior to obtaining REST API Production credentials, it is first necessary for the development to be signed off by our technology partner.
When you, as a developer, have completed your development with the Claims Portal Integration/Test environment, please download the below Sign Off Pack which contains detailed instructions regarding what you need to do to be signed off.
It is important to read the whole Sign Off Pack as it includes: -
- A confirmation that your development is compliant with the technical specifications regarding call frequency and special characters,
- Several scenarios for both RTA and ELPL to be completed to enable our technology partner to verify that the methods necessary to meet the scenarios listed have been completed in accordance with the technical specifications, and
- A list of methods for both RTA and ELPL for you to indicate which are included within your development and which aren’t.
Please submit the completed Sign Off Pack to helpdesk@rapidclaimsettlement.org.uk and include in the subject line the following wording “REST API Sign Off Pack – [COMP, CR or Software House name]”
Please note that the sign off process can take up to 5 business days and can take longer during peak periods.
Completing the REST API Credentials form below will allow you to obtain your client_id and client_secret for the Claims Portal Production REST API interface. Before making the request your development will need to be have been signed off by our technology partner.
