Midwinter API - Setup
How to setup Midwinter API at Inherit Australia
This document details the steps required to setup Midwinter API at Inherit Australia. This workflow setup is only required to be done once per practice
Before you begin
Please ensure you have access to the following:
1. Login credentials to Midwinter AdviceOs website with Admin rights.
2. Inherit Australia account with Admin or Primary account holder credentials (access to Settings / API menu items)
If you don’t have an Inherit Australia account, register with your ASIC Rep number or select option 2 for manual activation. https://landing.inheritaustralia.com.au/Register
Setup Midwinter API
This workflow requires you to undertake three steps:
1. Sign Midwinter API License Agreement.
2. Generate API code at Midwinter AdviceOs Website.
3. Connect to Inherit Australia.
Sign Midwinter API License Agreement
1. Complete and sign Midwinter's API Licence Agreement (below) and sent it to info@midwinter.com.au.
Note: Digital signature accpated
2. Midwinter will then return a copy of the executed agreement to you and configure your API permissions.
Generate API Code at Midwinter AdviceOs
1. log in to Midwinter at
2. Rollover Home, and select Setting > Api Config > Generate API Key
3. At the "Generate API Key" page, Select Practice Level API and Production Environment. Click "Generate API Key" and copy the key.
Connect to Midwinter from Inherit Australia
1. Login to Inherit Australia at: https://landing.inheritaustralia.com.au
If you don't have an account, register with your ASIC Rep number or select option 2 for manual activation.
2. Click setting (Cogwheel ) and API
3. Select Iress Midwinter
4. Copy and paste the API Key generated above to the box.
5. Click "Create"
9. Click "Done" at the original tab to refresh API Status.
10. Continue to Test the connection
Test Midwinter API Connection
Once you establish an API connection with Midwinter, It is advisable to test the connection by a client search.
1. From the API page, click "Test Search."
2. Enter a client name and click "Search". A valid test result will return the client's first and last names.
Your connection is now validated.
What next? continue to create an Estate plan with Midwinter API
