top of page

XPLAN API - Setup

How to setup XPLAN API at Inherit Australia

This document details the steps required to setup XPLAN API at Inherit Australia. This workflow setup is only required to be done once per practice or when XPLAN Credentials have expired

1280px-Iress_logo.png
InheritAustralia_symbol.png
Before you begin

Please ensure you have access to the following:

1. Login credentials to XPLAN website with Admin rights (access to admin/site menu items)

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 XPLAN API

This workflow requires you to undertake three steps:

1. Add Inherit Australia at XPLAN Website (Iress Open).

2. Connect to Inherit Australia.

3. Test connection.

Add Inherit Australia at Iress XPLAN

 

1. Login to XPLAN

2. Open the sidebar and search for IRESS open / Or: Navigate to Admin > Site > System settings > IRESS open​

2. Search for Inherit Australia tile

xplan2.png

3. Click Inherit Australia Tile, and "Activate"

xplan3.png
Add Inherit Australia at Iress XPLAN
Connect to XPLAN 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 XPLAN

xplan4.png

4. Enter your XPLAN site address, and click "Create."

XPLAN Site address format: {practicename}.xplan.iress.com.au

5. Click "Create"

xplan4.1.png

6. Click "Connect to XPLAN".

xplan5.png

7.  This action will open a new tab and XPLAN Login or Authorisation page. Login to your account if required.

Click "Allow" to enable Inherit Australia link

xplan6.png

8.  Once allowed, XPLAN will redirect to Inherit Australia confirmation page. Click "Close tab" to get back to Inherit Australia

xplan7.png

9.  Click "Done" at the original tab to refresh API Status.

10. Continue to Test the connection

Connect to XPLAN from Inherit Australia
Test XPLAN API Connection 

 

Once you establish an API connection with XPLAN, It is advisable to test the connection by a client search.

1. From the API page, click "Test Search."

xplan8.png

2. Enter client name or XPLAN ID and click "Search". A valid test result will return the client first and last names.

xplan9.png

Your connection is now validated.

What next? continue to create an Estate plan with XPLAN API

Test XPLAN API Connection 
bottom of page