We aim to make the process for partners integrating with our API straightforward, by following these simple steps:
- Create an account;
- Kick off call;
- Development phase;
- Go live.
More details on each of these steps can be found below.
1. Account Creation
Before you can start interacting with our API, you must apply for an API account, even if you are already working with us.
If you are integrating with our API for insurance products, then the process is different than that set out below, due to regulations imposed by the Financial Conduct Authority. Please contact our Insurance Team in the first instance, who will be happy to talk you through the process of account creation.
All other products:
Please complete the sign up form, which is automatically submitted to us upon completion.
You are also required to submit one of the following finance forms to us, depending on your region:
Once all the information has been received, we aim to set up the account within 48 hours (if submitted at weekends or bank holidays, this will not be processed until the following working day).
When completed, the finance forms should be sent by email to either our UK or European Partnerships teams (depending on your region). We will respond with your account details and any further instructions for getting started.
2. Kick off call
Once your account has been created you will be assigned an Account Manager, who will support you throughout the integration process. The initial contact with your Account Manager will be either a conference call or face to face meeting (whichever is most practical), which will cover more detail around the scope of the integration and provide an overview of how our API works. Technical support will also be available on this call.
More details can be found in the kick off document.
3. Development phase
During the development phase, your Account Manager will be contactable to answer any queries you may have. We will agree in the kick off call the level of support you require, which will depend on the complexity of your integration and the timescales for completing it. For example, we can set up regular calls to review progress, and provide technical contact details to support with integration queries.
Once you have completed your development we will invite you to a call to seek certification for your integration. This is an important step as it enables us to check you are using our API correctly.
The key parts of certification are use case testing, load testing and security. We will expect to review examples of requests made and responses received for each product you are using.
More details can be found in the certification checklist.
5. Go Live
Once we are satisfied that your integration meets the requirements in the certification check we will add your production credentials to our systems and notify you of the details. We will agree a date by which you will complete your integration and be live in production.
It is the final stage in the integration process, so we will also ensure that all outstanding issues have been rectified, and that we have the correct reporting in place, so we can monitor performance from go live.
Once your integration is live the day to day management of the account will be handled by the Account Manager, as agreed between us.