The Iress Open Standard integration is a productized API access pattern for common Xplan integration use cases. Designed for third-party applications, it offers a repeatable way to connect to Xplan sites using RESTful API services documented in Swagger.
Access is governed by API keys, user permissions, and agreed capabilities. Once an integration is built and approved by Iress **, mutual clients can quickly enable it site-by-site, significantly reducing deployment time.
How it Works
Iress utilizes a Backend For Frontend (BFF) layer to simplify Xplan connectivity. This layer logically groups existing API calls, reducing traffic between the integrator and Xplan. For instance, to extract contact information, an integrator makes a single request, and the data from multiple underlying calls (e.g., title, first name, surname, etc.) is returned in one response..
The pattern is real-time and bi-directional, supporting data retrieval (GET), creation (POST), modification (PATCH), and deletion (DELETE). Some limitations do apply for security and data protection purposes.
Data Fields in Scope
The Standard Integration services core Xplan fields, (not custom), to ensure quick and repeatable deployments.
Address |
| Goal |
|---|
Asset |
| Liability |
Client |
| Expense |
Contact |
| Income |
Dependant |
| Retirement Income |
Document Note (*) |
| Pension |
Insurance Summary |
| Portfolio (*) |
Insurance Detail - General / Medical / Life |
| Locale Specific - i.e. Superannuation |
(*) - some restrictions apply to write capabilities.
Note: Integrators may utilize all or a subset of the available endpoints and methods, depending on their solution requirements and product evolution.
A full list of the data available under each endpoint is detailed in the publicly published swagger documentation - links to which are below:
If you are a third party interested in pursuing an integration opportunity with Iress please contact the relevant team (link to (3))
** Please note Iress are not responsible for actively or extensively vetting Third-Party Integrators. Ownership of third party Due Diligence sits with the client electing to activate that integration.
