Connect Overview

Products introduction

Simpology Connect provides a single source of truth for loan product information. Comprehensive loan data can be managed, published, and subscribed to.

Loan information is managed through the Simpology Admin portal, you can manage your own loan information or simply subscribe to the existing loan data already published on the platform.

Loan information includes:

• Base product information
• All variations of the base product
• All features of the product
• Ongoing and once off fees and charges
• Comparison rates and discount packages
• Documents including PDS and product info

Products overview

A loan product is structured as a base product with a set of variations based on "varying features", plus a number of objects which contain information relating to features, fees, and notes.

As shown below, each lender may have multiple products and each product can have multiple variations.

• Base product information, provides key information enabling identification of the loan, primary loan purpose, and who the lender is.
• The interest rate may vary depending on loan options or features which may be selected. Each adjustment to the interest rate will cause a product variation to be listed. This creates a set of product variations.
• In addition to features which vary the interest rate, features which affect validity are also available, as well as universal features which highlight other benefits of the loan which may be available.
• Depending on which web method is invoked, in addition to the base and full product objects, and object which contains fees, notes and documents will also be provided.
• If discount packages are available from the lender, a discount package will also be returned. Additionally, comparison rates will be provided with and without taking the discount package into account.

Products features

Most loan products have lots of cool features e.g. Offset or redraw accounts, which need to be listed for information and comparative purposes.

Feature functionality is summarised below

Feature enumeration

The Simpology platform provides coverage across all lenders, with varying product structures and features, the platform is highly flexible and allows lenders to name features any way the prefer. In order to ensure loan products can be compared on a like for like basis, an underlying set of feature enumerations is provided so that loans can be readily compared in a consistent and accurate manner.

Products feature filters

Several of the API methods that are used to retrieve a list of products, have a product selection filter. The feature filters in the product filter will limit the products returned to those which match them.

The feature filters are described in the table below. Note that if there are multiple filters, only products that match ALL filters will be returned.

{
"featureTypeCode": "LVR",
"lowerValue": 50,
"upperValue": 90
}

{
"featureTypeCode": "LoanAmount",
"lowerValue": 2500000,
"upperValue": 90000000
}
			

{
"featureTypeCode": "State",
"featureOptionCodes": [
"NSW",
"Vic"
]
}

{
"featureTypeCode" :StandardFeaturesWithoutValue",
"standardFeatureOptionCode" : "ChequeBook",
"isPresent" : true
}

{
"featureTypeCode": "StandardFeaturesWithValue",
"standardFeatureOptionCode" : "MaximumLoanAmount",
"value" : "100000"
}
			

{
"featureTypeCode": "PostCode",
"value" : "2000,2011,3000,3200"
}
			

Products API Methods

• Data subscription - delivers details of your published data as well as data you have subscribed to.
• Document - returns the list of documents for a lender or a product. There is also a method to stream the document contents.
• Lender - returns a list of all lenders whose products you have subscribed to. Use this data to iterate through lenders to retrieve only the data you require.
• Product - returns either the base product information or the full product details with all associated objects. Also returns the a default product which is a full product object but with only the default variation included, useful for basic loan comparison. The calculator method provides the same outcome as the default method but with the additional advantages of specifying search criteria and of a custom calculated comparison rate based on the actual loan term and loan amount.
• Product details - returns the extra loan product data associated with the selected loan product. This includes, features, fees, and notes. Note that the full product object includes these objects as well.

Please review these methods and their associated data model schemas on the swagger page.

For the object model see the Model page.

Products API Return Codes

The API uses a subset of the standard HTTP return codes. The codes that are used are:

{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "|eed66cfc-4e2be9c306e8a251.",
"errors": {
"LVR": [
  	"UpperValue must be greater than LowerValue"
]
}
}
					

Serviceability overview

Provide third party services as PASSASS.

• PAYG Income
• Self Employed
• Not Employed
• Company and Trust
• Rental Income
• Mortgage Liability
• Other Liability
• CALC PAIncome
• Household Expenses

Serviceability API Methods

• Serviceability - Returns a list of all available serviceability calculators, Returns the result of the serviceability calculation.
• Serviceability - returns the list of documents for a lender or a product. There is also a method to stream the document contents.
• Serviceability Config - Returns a list of all available metrics or by selected set.

Please review these methods and their associated data model schemas on the swagger page.

For the object model see the Model page.

Serviceability API Return Codes

The API uses a subset of the standard HTTP return codes. The codes that are used are:

{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "|eed66cfc-4e2be9c306e8a251.",
"errors": {
"LVR": [
  	"UpperValue must be greater than LowerValue"
]
}
}
					

LIXI Application Management overview

These LIXI compatible APIs to handle CRUD operations (create, read, update and delete) for loan applications originating from a CRM system. Expected data formats are CAL/CNZ 2.6.x or greater.

• Create a new application in Loanapp
• Open an existing application in Loanapp
• Copy an existing application into a new one with a new identifier.
• Delete an application from Loanapp.
• Query the applications stored in Loanapp.
• Change sales channel or the application name.
• Provide the status of the application.

LIXI Application Management API Methods

• Create Application - Create a new application in Loanapp.
• Open Application - Open an existing application in Loanapp.
• Copy Application - Copy an existing application into a new one with a new identifier.
• Delete Application - Delete an application from Loanapp.
• List Applications - Query the applications stored in Loanapp.
• Update Application - Change sales channel or the application name.
• Application status - Provide the status of the application.

Please review these methods and their associated data model schemas on the swagger page.

For the object model see the Model page.

LIXI Application Management API Return Codes

The API uses a subset of the standard HTTP return codes. The codes that are used are:

{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "|eed66cfc-4e2be9c306e8a251.",
"errors": {
"LVR": [
  	"UpperValue must be greater than LowerValue"
]
}
}
					

LITE Application Management overview

Support for managing lite applications. Lite applications have much smaller data model compared to full featured LIXI or LADM applications. APIs for managing applicants, documents and CRUD operations (create, read, update and delete) for loan applications.

• Create a new application in Loanapp
• Delete an application from Loanapp.
• Update an existing application details in Loanapp.
• Create a new applicant in Loanapp.
• Get applicants from Loanapp.
• Create new management persons in Loanapp.
• Get templates from Loanapp.
• Save document for an application.

LITE Application Management API Methods

• LITE - Provides application, applicant, document CRUD operations for lite loan applications.

Please review these methods and their associated data model schemas on the swagger page.

For the object model see the Model page.

LITE Application Management API Return Codes

The API uses a subset of the standard HTTP return codes. The codes that are used are:

{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "|eed66cfc-4e2be9c306e8a251.",
"errors": {
"LVR": [
  	"UpperValue must be greater than LowerValue"
]
}
}
					

LADM Application Management overview

Get a LADM application in JSON format.

LADM Application Management API Methods

• LADM - Returns details of LADM application.

Please review these methods and their associated data model schemas on the swagger page.

For the object model see the Model page.

LADM Application Management API Return Codes

The API uses a subset of the standard HTTP return codes. The codes that are used are:

{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "|eed66cfc-4e2be9c306e8a251.",
"errors": {
"LVR": [
  	"UpperValue must be greater than LowerValue"
]
}
}
					

Broker overview

Get broker by id or email.

Broker API Methods

• Broker - Returns a broker details.

Please review these methods and their associated data model schemas on the swagger page.

For the object model see the Model page.

Broker API Return Codes

The API uses a subset of the standard HTTP return codes. The codes that are used are:

{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "|eed66cfc-4e2be9c306e8a251.",
"errors": {
"LVR": [
  	"UpperValue must be greater than LowerValue"
]
}
}
					

Info Request overview

Send or get info request details or template.

• Send info request.
• Send info request from template.
• Get info request documents.
• Get info request templates.
• Get info request status.

Info Request API Methods

• InfoRequestExternal - Send or get info request details or template.

Please review these methods and their associated data model schemas on the swagger page.

For the object model see the Model page.

Info Request API Return Codes

The API uses a subset of the standard HTTP return codes. The codes that are used are:

{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "|eed66cfc-4e2be9c306e8a251.",
"errors": {
"LVR": [
  	"UpperValue must be greater than LowerValue"
]
}
}