-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7c61a34
commit 1fe5702
Showing
1 changed file
with
51 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,51 +1,58 @@ | ||
| ## Welcome to XAI Validate | ||
| ## Welcome to Xapii by Tiimely | ||
|
|
||
| Use our Xapii API documentation to begin your **pursuit of seamless**. At Tiimely, we provide some of Australia's most prominent lenders and brands with highly configurable solutions that businesses can use throughout their lending offerings. | ||
|
|
||
| Market leaders in home lending, consumer lending, credit cards, auto finance, and hardship utilise Xapii APIs to complement, not replace, their existing tech stack to optimise customer outcomes, create engaging journeys, and meet compliance obligations. | ||
|
|
||
| With Xapii APIs, you can: | ||
| - Convert - reduce time and cost to 'yes' with tools that improve conversion | ||
| - Decide - Automated real-time lending decisioning configured to your product and policy requirements | ||
| - Fulfil - create a faster, more compliant path to loan completion | ||
| - Inform - leverage Tiimely's data capabilities and insights to mitigate risks and identify business growth opportunities | ||
|
|
||
| Ready to start your pursuit of seamless? | ||
|
|
||
| [Contact us](mailto:[email protected]) to discuss which product is right for you and to gain access to our sandbox. | ||
|
|
||
| ### Xapii by Tiimely supports a range of data sources, including: | ||
| - Popular data aggregators (illion or Yodlee) | ||
| - Connect your own data | ||
| - Consumer Data Right (CDR) | ||
| - Comprehensive Credit Report (CCR) data - coming soon! | ||
| - Digitised documents (OCR) - coming soon! | ||
|
|
||
| The following table provides information on the data sources that are supported and the essential details to include your requests. By default, you can use two data sources — your selected data aggregator and the option 'connect your own data'. | ||
|
|
||
| XAI Validate is powered by [Tic:Toc](https://tictoc.ai), a technology solutions company providing innovative products to make financial services processes faster, smarter and simpler. | ||
|
|
||
|
|
||
| XAI Validate solves for digital financial data validation using Explainable Artificial Intelligence (XAI) models to distil and render the customers’ financial data into an application decision summary. It is powered by a set of sophisticated normalisation, categorisation and assessment models, supported by an intuitive user interface that allows assessors to interact with and understand your customers' financial data. This will dramatically reduce the time required for assessment and to increase conversion, while ensuring process assurance and credit quality. We prove all technology against our direct to consumer home loans business, [Tic:Toc Home Loans](https://tictoc.com.au/). | ||
|
|
||
| If you're a lender you can use XAI Validate in two ways: | ||
| - **Detect and Position** (Actuals only): instantly identify income, expenses, assets and liabilities, behavioural and risk insights. | ||
| - **Verify and Decision** (Stated vs Actuals): ingest and verify customers’ declared financials against the actual financial position identified in the data. This also allows you to configure your credit policy automating responsible lending assessment decisions. | ||
|
|
||
| XAI Validate supports a range of data sources including: | ||
| - popular data aggregators | ||
| - connect your own data | ||
| - Consumer Data Right support (coming soon!) | ||
| |**Data Source**|**Data Provider Name**|**Date Provider Reference**|**Details**| | ||
| |---|---|---|---| | ||
| |illion ODS BrokerFlow|`ODS`|A list of your BrokerFlow `DocumentIds`.|You can provide multiple `DocumentIds` for each applicant.| | ||
| |illion ODS MultiBank|`MB`|None|We will provide a unique URL for each applicant. When used by your customers, their accounts will link and their data will automatically sync to the corresponding application in Xapii.| | ||
| |Yodlee v1.1|`YOD11`|A list of your Yodlee customer identifiers.|There is a one-to-one linking of the applicant to the Yodlee customer identifier.| | ||
| |Yodlee v1.1 (CDR "outsource service provider")|`YOD11`|A list of your Yodlee customer identifiers.|There is a one-to-one linking of the applicant to the Yodlee customer identifier.| | ||
| |Connect your own data|`EXT`|None|When using external API data (`EXT`) you'll be required to upload your data to the application. Check out `/financialvalidation/provideaccounts` for more information.| | ||
| ## Getting Started | ||
|
|
||
| The XAI Validate API provides a way to seamlessly integrate assessment of financial poistion into your workflow. The table below provides a summary of endpoints, which allow you to get "data in" and then "data out". You can use the [XAI Validate user interface](https://app.tictoc.ai) at any time to interact with your data and the automated assessment of financial position. | ||
|
|
||
| The Xapii by Tiimely API provides a way to seamlessly integrate assessment of financial poistion into your workflow. The table below provides a summary of endpoints, which allow you to get "data in" and then "data out". You can use the [Xapii by Tiimely user interface](https://app.tiimely.com) at any time to interact with your data and the automated assessment of financial position. | ||
|
|
||
| You'll need the following to start developing: | ||
| - sign-up for XAI Validate. [Contact us](mailto:[email protected]) to discuss the right product and access to our `sandbox` | ||
| - your client credentials for the XAI Validate user interface and API. These will provided to you by Tic:Toc, and must be stored securely | ||
| - you're then ready to start developing against our test environment using the endpoints below. | ||
|
|
||
| | Endpoint Name| Description | | ||
| |-----|-----| | ||
| | [`/application/create`](#/financialvalidation/application/create) | Create an application linking your applicants, and their external data aggregator reference identifiers. | | ||
| | [`/application/manage`](#/financialvalidation/application/manage) | Update an existing application including adding "declared/stated" financials, updating applicant details or adding new xternal data aggregator reference identifiers. | | ||
| | [`/provideaccounts`](#/financialvalidation/provideaccounts) | Connect your customers' account and transaction data against an existing application and applicant. This is ideal if you've sourced your own raw transaction data from core systems or through Open Banking. | | ||
| | [`/application/getstatus`](#/application/getstatus) | Monitor the progress of automated financial assessment. | | ||
| | [`/result/getsummary`](#/result/getsummary)| Retrieve the results of automated financial assessment. The endpoint will surface automated assessments against your configured credit policy (where relevant), and validation figures for income, expenses, assets and liabilities. | | ||
| | [`/serviceability/getserviceability`](#/serviceability/getserviceability)| Calculate serviceability for your application including income, expense, debt, borrowing amount and ratios. | | ||
| | [`/token`](#/token) | XAI Validate uses OAuth2 authentication. Every time you call these endpoints you'll need to ensure you have a valid token. | | ||
| - sign-up for Xapii by Tiimely. [Contact us](mailto:[email protected]) to discuss the right product and access to our `sandbox` | ||
| - your client credentials for the Xapii by Tiimely user interface and API. These will provided to you by Xapii by Tiimely, and must be stored securely | ||
| - you're then ready to start developing against our test environment using the endpoints below. | ||
|
|
||
|
|
||
| ## Data Model | ||
| When you interact with the XAI Validate user interface and APIs you'll notice there's a clear structure to the data. We've designed the XAI Validate data model to be optimised for automating assessment of financial position. The data hierarchy is: | ||
| - **application**: this is the structure that holds all other elements and represents a point-in-time product application from your customer | ||
| - **applicants**: an application can have one or more applicants (currently limited to two). Applicants can belong to multiple applications, e.g. a customer applying for a credit card and a home loan would exist in two applications | ||
| - **households**: your applicants belong to households. For convenience we will assign applicants to a single, default household at the start of application | ||
| - **accounts**: applicants own accounts, which can be held individually or jointly with the other applicant on the application | ||
| - **transactions**: these are the credits and debits against each account. Transactions are enriched with attributes such as categories, high risk flags and expense management. | ||
|
|
||
|
|
||
| When you interact with the Xapii by Tiimely user interface and APIs you'll notice there's a clear structure to the data. We've designed the Xapii by Tiimely data model to be optimised for automating assessment of financial position. The data hierarchy is: | ||
| - **application**: this is the structure that holds all other elements and represents a point-in-time product application from your customer | ||
| - **applicants**: an application can have one or more applicants (currently limited to two). Applicants can belong to multiple applications, e.g. a customer applying for a credit card and a home loan would exist in two applications | ||
| - **households**: your applicants belong to households. For convenience we will assign applicants to a single, default household at the start of application | ||
| - **accounts**: applicants own accounts, which can be held individually or jointly with the other applicant on the application | ||
| - **transactions**: these are the credits and debits against each account. Transactions are enriched with attributes such as categories, high risk flags and expense management. | ||
| - **documents**: each application and applicant can have a document linked, each with a defined type and format. | ||
|
|
||
| ## References | ||
|
|
||
| Here are a few resources to help you on your way: | ||
| - **User guide**: you can access this through the XAI Validate application. Simply login and navigate to your name in the top right. | ||
| - **SDKs**: coming soon | ||
| - **Postman 'Collection'**: download this collection to help you interact with the XAI Validate APIs using Postman (coming soon). | ||
| - **User guide**: you can access this through the Xapii by Tiimely application. Simply login and navigate to your name in the top right. | ||
| - **SDKs**: coming soon | ||
| - **Postman 'Collection'**: download this collection to help you interact with the Xapii by Tiimely APIs using Postman (coming soon). |