diff --git a/XAI Validate API Collection.postman_collection.json b/XAI Validate API Collection.postman_collection.json index 32e62d3..d10212e 100644 --- a/XAI Validate API Collection.postman_collection.json +++ b/XAI Validate API Collection.postman_collection.json @@ -1,7 +1,7 @@ { "info": { "_postman_id": "ee10f301-0871-41c9-9deb-325c4726f9d1", - "name": "XAI Validate API Collection", + "name": "Xapii API Collection", "description": " ", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, @@ -77,7 +77,7 @@ } ] }, - "description": "Before you can call the XAI Validate endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the XAI Validate team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" + "description": "Before you can call the Xapii endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the Xapii team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" }, "response": [] }, @@ -139,7 +139,7 @@ "create" ] }, - "description": " This endpoint allows you to create an \"application\", which is the object that holds all elements and represents a point-in-time product application from your customer. XAI Validate assigns each application a unique `ApplicationReferenceNumber` (Arn). You can use this value for subsequent calls.\r\n \r\n \r\n When you create an application you determine the data sources and data validation type you need, namely:\r\n 1. \"Detect and Position\" or \"declare and verify\": do you want XAI Validate to identify your customers' financial position and provide you with the insights or do you want XAI Validate to automate financial validation decisioning for you? If you choose a \"declare and verify\" approach you need to provide your customers' \"declared\" financials to the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.\r\n 2. your customers: you can link one or more applicants to an application. XAI Validate will combine any jointly held accounts as part of the linking process.\r\n 3. your customer data source: XAI Validate supports multiple data sources. See the table below for more information.\r\n \r\n \r\n The table below lists the parameters you need to populate based on your data validation choice above:\r\n \r\n | Function | Description |\r\n |-----|-----| \r\n | `ApplicationContacts` | These are the applicants applying for your product. XAI Validate currently supports up to two applicants.|\r\n | `ExternalDataId`| This is the reference information for your existing data aggregator. XAI Validate currently supports multiple data sources - see the table below for information.|\r\n | `ExternalApplicationReferenceNumber`| This is an application reference from your own system to allow you to easily correlate the XAI Validate `ApplicationReferenceNumber` with your own records.|\r\n | `IsActualsOnly`| This parameter is only used by those clients that require a \"declare and verify\" approach to financial assessment. By setting this boolean to `false` these customers can then call the [`/application/manage`](#/application/manage) endpoint to add their applicants' \"declared\" or \"stated\" financials. This value will default to `true` meaning XAI Validate will return your applicants' \"actual\" financial position from the data. If don't pass a value for `IsActualsOnly`, then automated assessment will be triggered when you receive a successful response. If you're passing `\"IsActualsOnly\": false` then automated assessment will wait for you provide your applicants' \"declared\" financials via the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.|\r\n \r\n XAI Validate supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your XAI Validate client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your XAI Validate application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Basiq (coming soon!) | `BSQ` | As list of your Basiq customer identifiers. | You should have a one to one linking of applicant to Basiq customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " + "description": " This endpoint allows you to create an \"application\", which is the object that holds all elements and represents a point-in-time product application from your customer. Xapii assigns each application a unique `ApplicationReferenceNumber` (Arn). You can use this value for subsequent calls.\r\n \r\n \r\n When you create an application you determine the data sources and data validation type you need, namely:\r\n 1. \"Detect and Position\" or \"declare and verify\": do you want Xapii to identify your customers' financial position and provide you with the insights or do you want Xapii to automate financial validation decisioning for you? If you choose a \"declare and verify\" approach you need to provide your customers' \"declared\" financials to the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.\r\n 2. your customers: you can link one or more applicants to an application. Xapii will combine any jointly held accounts as part of the linking process.\r\n 3. your customer data source: Xapii supports multiple data sources. See the table below for more information.\r\n \r\n \r\n The table below lists the parameters you need to populate based on your data validation choice above:\r\n \r\n | Function | Description |\r\n |-----|-----| \r\n | `ApplicationContacts` | These are the applicants applying for your product. Xapii currently supports up to two applicants.|\r\n | `ExternalDataId`| This is the reference information for your existing data aggregator. Xapii currently supports multiple data sources - see the table below for information.|\r\n | `ExternalApplicationReferenceNumber`| This is an application reference from your own system to allow you to easily correlate the Xapii `ApplicationReferenceNumber` with your own records.|\r\n | `IsActualsOnly`| This parameter is only used by those clients that require a \"declare and verify\" approach to financial assessment. By setting this boolean to `false` these customers can then call the [`/application/manage`](#/application/manage) endpoint to add their applicants' \"declared\" or \"stated\" financials. This value will default to `true` meaning Xapii will return your applicants' \"actual\" financial position from the data. If don't pass a value for `IsActualsOnly`, then automated assessment will be triggered when you receive a successful response. If you're passing `\"IsActualsOnly\": false` then automated assessment will wait for you provide your applicants' \"declared\" financials via the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.|\r\n \r\n Xapii supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your Xapii client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your Xapii application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " }, "response": [] }, @@ -185,7 +185,7 @@ "getstatus" ] }, - "description": " Retrieve the status of your automated financial assessment process. Financial validation has a diverse range of activities from retrieving provider data, normalising accounts and transactions, through to automated assessment of financial position. A `GroupId` will be returned in the response for the following endpoints, which you can use to monitor progress:\r\n - [`/application/create`](#/application/create)\r\n - [`/application/manage`](#/application/manage)\r\n \r\n We will return an overall status of the financial validation tasks. The status codes are:\r\n - `READY` - task processing has not yet started \r\n - `PROCESSING` - task processing is underway\r\n - `COMPLETED` - task processing has completed successfully\r\n - `FAILED` - a task has failed processing. XAI Validate will retry the task, so continue to monitor.\r\n - `DEAD` - oops... something's gone wrong. No further processing takes place - we'll monitor the system for these issues.\r\n " + "description": " Retrieve the status of your automated financial assessment process. Financial validation has a diverse range of activities from retrieving provider data, normalising accounts and transactions, through to automated assessment of financial position. A `GroupId` will be returned in the response for the following endpoints, which you can use to monitor progress:\r\n - [`/application/create`](#/application/create)\r\n - [`/application/manage`](#/application/manage)\r\n \r\n We will return an overall status of the financial validation tasks. The status codes are:\r\n - `READY` - task processing has not yet started \r\n - `PROCESSING` - task processing is underway\r\n - `COMPLETED` - task processing has completed successfully\r\n - `FAILED` - a task has failed processing. Xapii will retry the task, so continue to monitor.\r\n - `DEAD` - oops... something's gone wrong. No further processing takes place - we'll monitor the system for these issues.\r\n " }, "response": [] }, @@ -231,7 +231,7 @@ "getsummary" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] }, @@ -276,7 +276,7 @@ "getserviceability" ] }, - "description": " This endpoint allows you to get serviceability metrics for your applications. By passing the `ApplicationReferenceNumber` for an existing application you can use the validated financials from earlier [`/application/create`](#Application/Create) and [`/application/manage`](#Application/Manage) requests to get accurate serviceability outputs.\r\n \r\n In each request you can provide a list of new facilities, for which serviceability metrics will be returned. \r\n \r\n You will be required to supply the following required information:\r\n * `ApplicationReferenceNumber`: this will extract validated financials from the application object from earlier processes.\r\n * `NewFacilities`: specifics of the new debt facilities.\r\n * `ConfigurationSet`: the lending policy configuration for which you wish to calculate serviceability metrics. This will be the lender or product enumeration you have configured within XAI Validate\r\n\r\n If you require HEM calculations you can set the `IsHemRequired` optional parameter. This is set to `false` by default. If you set this value to `true` then you must provide the following additional values under the `ApplicationContacts` object:\r\n * `EmailAddress`\r\n * `Dependants`\r\n * `MartialStatus`\r\n * `ResidentialStatus`\r\n \r\n\r\n You also have the ability to provide additional applicant and application level values over and above the outputs from earlier financial validation processes. These are optional - we will use validated figures and configured defaults where these are not provided. The table below lists the high level optional objects for tailoring serviceability calculations.\r\n \r\n | Optional Value | Purpose |\r\n |-----|-----| \r\n | `ApplicantIncome` | Applicant-specific income values including self-employed income inputs and addbacks.|\r\n | `ApplicantDebt` | Applicant-specific liabilities including home loans and ownership percentage |\r\n | `ApplicationExpenses` | Household-specific expenses include non-discretionary expenses and HEM values |\r\n \r\n Please note: \r\n * If your applicant is self employed you will need to set the `IsSelfEmployed` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n * If your applicant has a HECS debt you will need to set the `HasHecsDebt` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n " + "description": " This endpoint allows you to get serviceability metrics for your applications. By passing the `ApplicationReferenceNumber` for an existing application you can use the validated financials from earlier [`/application/create`](#Application/Create) and [`/application/manage`](#Application/Manage) requests to get accurate serviceability outputs.\r\n \r\n In each request you can provide a list of new facilities, for which serviceability metrics will be returned. \r\n \r\n You will be required to supply the following required information:\r\n * `ApplicationReferenceNumber`: this will extract validated financials from the application object from earlier processes.\r\n * `NewFacilities`: specifics of the new debt facilities.\r\n * `ConfigurationSet`: the lending policy configuration for which you wish to calculate serviceability metrics. This will be the lender or product enumeration you have configured within Xapii\r\n\r\n If you require HEM calculations you can set the `IsHemRequired` optional parameter. This is set to `false` by default. If you set this value to `true` then you must provide the following additional values under the `ApplicationContacts` object:\r\n * `EmailAddress`\r\n * `Dependants`\r\n * `MartialStatus`\r\n * `ResidentialStatus`\r\n \r\n\r\n You also have the ability to provide additional applicant and application level values over and above the outputs from earlier financial validation processes. These are optional - we will use validated figures and configured defaults where these are not provided. The table below lists the high level optional objects for tailoring serviceability calculations.\r\n \r\n | Optional Value | Purpose |\r\n |-----|-----| \r\n | `ApplicantIncome` | Applicant-specific income values including self-employed income inputs and addbacks.|\r\n | `ApplicantDebt` | Applicant-specific liabilities including home loans and ownership percentage |\r\n | `ApplicationExpenses` | Household-specific expenses include non-discretionary expenses and HEM values |\r\n \r\n Please note: \r\n * If your applicant is self employed you will need to set the `IsSelfEmployed` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n * If your applicant has a HECS debt you will need to set the `HasHecsDebt` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n " }, "response": [] }, @@ -322,7 +322,7 @@ "getexpensesummary" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] } @@ -396,7 +396,7 @@ } ] }, - "description": "Before you can call the XAI Validate endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the XAI Validate team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" + "description": "Before you can call the Xapii endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the Xapii team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" }, "response": [] }, @@ -456,7 +456,7 @@ "create" ] }, - "description": " This endpoint allows you to create an \"application\", which is the object that holds all elements and represents a point-in-time product application from your customer. XAI Validate assigns each application a unique `ApplicationReferenceNumber` (Arn). You can use this value for subsequent calls.\r\n \r\n \r\n When you create an application you determine the data sources and data validation type you need, namely:\r\n 1. \"Detect and Position\" or \"declare and verify\": do you want XAI Validate to identify your customers' financial position and provide you with the insights or do you want XAI Validate to automate financial validation decisioning for you? If you choose a \"declare and verify\" approach you need to provide your customers' \"declared\" financials to the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.\r\n 2. your customers: you can link one or more applicants to an application. XAI Validate will combine any jointly held accounts as part of the linking process.\r\n 3. your customer data source: XAI Validate supports multiple data sources. See the table below for more information.\r\n \r\n \r\n The table below lists the parameters you need to populate based on your data validation choice above:\r\n \r\n | Function | Description |\r\n |-----|-----| \r\n | `ApplicationContacts` | These are the applicants applying for your product. XAI Validate currently supports up to two applicants.|\r\n | `ExternalDataId`| This is the reference information for your existing data aggregator. XAI Validate currently supports multiple data sources - see the table below for information.|\r\n | `ExternalApplicationReferenceNumber`| This is an application reference from your own system to allow you to easily correlate the XAI Validate `ApplicationReferenceNumber` with your own records.|\r\n | `IsActualsOnly`| This parameter is only used by those clients that require a \"declare and verify\" approach to financial assessment. By setting this boolean to `false` these customers can then call the [`/application/manage`](#/application/manage) endpoint to add their applicants' \"declared\" or \"stated\" financials. This value will default to `true` meaning XAI Validate will return your applicants' \"actual\" financial position from the data. If don't pass a value for `IsActualsOnly`, then automated assessment will be triggered when you receive a successful response. If you're passing `\"IsActualsOnly\": false` then automated assessment will wait for you provide your applicants' \"declared\" financials via the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.|\r\n \r\n XAI Validate supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your XAI Validate client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your XAI Validate application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Basiq (coming soon!) | `BSQ` | As list of your Basiq customer identifiers. | You should have a one to one linking of applicant to Basiq customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " + "description": " This endpoint allows you to create an \"application\", which is the object that holds all elements and represents a point-in-time product application from your customer. Xapii assigns each application a unique `ApplicationReferenceNumber` (Arn). You can use this value for subsequent calls.\r\n \r\n \r\n When you create an application you determine the data sources and data validation type you need, namely:\r\n 1. \"Detect and Position\" or \"declare and verify\": do you want Xapii to identify your customers' financial position and provide you with the insights or do you want Xapii to automate financial validation decisioning for you? If you choose a \"declare and verify\" approach you need to provide your customers' \"declared\" financials to the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.\r\n 2. your customers: you can link one or more applicants to an application. Xapii will combine any jointly held accounts as part of the linking process.\r\n 3. your customer data source: Xapii supports multiple data sources. See the table below for more information.\r\n \r\n \r\n The table below lists the parameters you need to populate based on your data validation choice above:\r\n \r\n | Function | Description |\r\n |-----|-----| \r\n | `ApplicationContacts` | These are the applicants applying for your product. Xapii currently supports up to two applicants.|\r\n | `ExternalDataId`| This is the reference information for your existing data aggregator. Xapii currently supports multiple data sources - see the table below for information.|\r\n | `ExternalApplicationReferenceNumber`| This is an application reference from your own system to allow you to easily correlate the Xapii `ApplicationReferenceNumber` with your own records.|\r\n | `IsActualsOnly`| This parameter is only used by those clients that require a \"declare and verify\" approach to financial assessment. By setting this boolean to `false` these customers can then call the [`/application/manage`](#/application/manage) endpoint to add their applicants' \"declared\" or \"stated\" financials. This value will default to `true` meaning Xapii will return your applicants' \"actual\" financial position from the data. If don't pass a value for `IsActualsOnly`, then automated assessment will be triggered when you receive a successful response. If you're passing `\"IsActualsOnly\": false` then automated assessment will wait for you provide your applicants' \"declared\" financials via the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.|\r\n \r\n Xapii supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your Xapii client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your Xapii application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " }, "response": [] }, @@ -513,7 +513,7 @@ "manage" ] }, - "description": " \r\n This versatile endpoint allows you to perform the following functions against an existing application:\r\n | Function | Description |\r\n |-----|-----| \r\n | Add/edit \"stated/declared\" financials against an application | This is only relevant if you require a \"declare and verify\" approach to financial assessment, and have passed the `\"IsActualsOnly\": false` parameter in your [`/application/create`](#Application/Create) request.|\r\n | Link additional data source to an application |This is useful when your applicants provide additional bank account information thorugh your data aggregator, and you need to rerun the automated assessment. Please see the table below for data source details. |\r\n | Add/edit applicants within an application (coming soon!)| Add new applicants or edit existing ones. |\r\n \r\n When you call the endpoint, automated assessment will commence once you receive a successful response. You can monitor the progress using the [`/application/getstatus`](#/application/getstatus) endpoint.\r\n \r\n Please note the assessment levels XAI Validate currently supports for providing \"stated/declared\" financials. These have been designed in line with lending best practices:\r\n \r\n | Assessment Level | Financial Types |\r\n |-----|-----|\r\n | `Application` | These are application-level financials (`DeclaredFinancialsApplication`) and currently accommodate `AssetsCash` for assessment of your applicants' deposit|\r\n | `Household` | Your applicants will belong to `Households` and the `DeclaredFinancialsHousehold` object currently supports `ExpensesMonthly` for your applicants' household's monthly expenses |\r\n | `Applicant` | These are the applicant-specific financials, which includes a `IncomeSalary` figure, a list of `IncomeRental` values, a list of `LiabilitiesHomeLoans` values, and single values for `LiabilitiesCreditCard*` and `LiabilitiesPersonalLoan*`|\r\n \r\n \r\n XAI Validate supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your XAI Validate client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your XAI Validate application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Basiq (coming soon!) | `BSQ` | As list of your Basiq customer identifiers. | You should have a one to one linking of applicant to Basiq customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " + "description": " \r\n This versatile endpoint allows you to perform the following functions against an existing application:\r\n | Function | Description |\r\n |-----|-----| \r\n | Add/edit \"stated/declared\" financials against an application | This is only relevant if you require a \"declare and verify\" approach to financial assessment, and have passed the `\"IsActualsOnly\": false` parameter in your [`/application/create`](#Application/Create) request.|\r\n | Link additional data source to an application |This is useful when your applicants provide additional bank account information thorugh your data aggregator, and you need to rerun the automated assessment. Please see the table below for data source details. |\r\n | Add/edit applicants within an application (coming soon!)| Add new applicants or edit existing ones. |\r\n \r\n When you call the endpoint, automated assessment will commence once you receive a successful response. You can monitor the progress using the [`/application/getstatus`](#/application/getstatus) endpoint.\r\n \r\n Please note the assessment levels Xapii currently supports for providing \"stated/declared\" financials. These have been designed in line with lending best practices:\r\n \r\n | Assessment Level | Financial Types |\r\n |-----|-----|\r\n | `Application` | These are application-level financials (`DeclaredFinancialsApplication`) and currently accommodate `AssetsCash` for assessment of your applicants' deposit|\r\n | `Household` | Your applicants will belong to `Households` and the `DeclaredFinancialsHousehold` object currently supports `ExpensesMonthly` for your applicants' household's monthly expenses |\r\n | `Applicant` | These are the applicant-specific financials, which includes a `IncomeSalary` figure, a list of `IncomeRental` values, a list of `LiabilitiesHomeLoans` values, and single values for `LiabilitiesCreditCard*` and `LiabilitiesPersonalLoan*`|\r\n \r\n \r\n Xapii supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your Xapii client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your Xapii application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " }, "response": [] }, @@ -559,7 +559,7 @@ "getstatus" ] }, - "description": " Retrieve the status of your automated financial assessment process. Financial validation has a diverse range of activities from retrieving provider data, normalising accounts and transactions, through to automated assessment of financial position. A `GroupId` will be returned in the response for the following endpoints, which you can use to monitor progress:\r\n - [`/application/create`](#/application/create)\r\n - [`/application/manage`](#/application/manage)\r\n \r\n We will return an overall status of the financial validation tasks. The status codes are:\r\n - `READY` - task processing has not yet started \r\n - `PROCESSING` - task processing is underway\r\n - `COMPLETED` - task processing has completed successfully\r\n - `FAILED` - a task has failed processing. XAI Validate will retry the task, so continue to monitor.\r\n - `DEAD` - oops... something's gone wrong. No further processing takes place - we'll monitor the system for these issues.\r\n " + "description": " Retrieve the status of your automated financial assessment process. Financial validation has a diverse range of activities from retrieving provider data, normalising accounts and transactions, through to automated assessment of financial position. A `GroupId` will be returned in the response for the following endpoints, which you can use to monitor progress:\r\n - [`/application/create`](#/application/create)\r\n - [`/application/manage`](#/application/manage)\r\n \r\n We will return an overall status of the financial validation tasks. The status codes are:\r\n - `READY` - task processing has not yet started \r\n - `PROCESSING` - task processing is underway\r\n - `COMPLETED` - task processing has completed successfully\r\n - `FAILED` - a task has failed processing. Xapii will retry the task, so continue to monitor.\r\n - `DEAD` - oops... something's gone wrong. No further processing takes place - we'll monitor the system for these issues.\r\n " }, "response": [] }, @@ -605,7 +605,7 @@ "getsummary" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] }, @@ -650,7 +650,7 @@ "getserviceability" ] }, - "description": " This endpoint allows you to get serviceability metrics for your applications. By passing the `ApplicationReferenceNumber` for an existing application you can use the validated financials from earlier [`/application/create`](#Application/Create) and [`/application/manage`](#Application/Manage) requests to get accurate serviceability outputs.\r\n \r\n In each request you can provide a list of new facilities, for which serviceability metrics will be returned. \r\n \r\n You will be required to supply the following required information:\r\n * `ApplicationReferenceNumber`: this will extract validated financials from the application object from earlier processes.\r\n * `NewFacilities`: specifics of the new debt facilities.\r\n * `ConfigurationSet`: the lending policy configuration for which you wish to calculate serviceability metrics. This will be the lender or product enumeration you have configured within XAI Validate\r\n\r\n If you require HEM calculations you can set the `IsHemRequired` optional parameter. This is set to `false` by default. If you set this value to `true` then you must provide the following additional values under the `ApplicationContacts` object:\r\n * `EmailAddress`\r\n * `Dependants`\r\n * `MartialStatus`\r\n * `ResidentialStatus`\r\n \r\n\r\n You also have the ability to provide additional applicant and application level values over and above the outputs from earlier financial validation processes. These are optional - we will use validated figures and configured defaults where these are not provided. The table below lists the high level optional objects for tailoring serviceability calculations.\r\n \r\n | Optional Value | Purpose |\r\n |-----|-----| \r\n | `ApplicantIncome` | Applicant-specific income values including self-employed income inputs and addbacks.|\r\n | `ApplicantDebt` | Applicant-specific liabilities including home loans and ownership percentage |\r\n | `ApplicationExpenses` | Household-specific expenses include non-discretionary expenses and HEM values |\r\n \r\n Please note: \r\n * If your applicant is self employed you will need to set the `IsSelfEmployed` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n * If your applicant has a HECS debt you will need to set the `HasHecsDebt` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n " + "description": " This endpoint allows you to get serviceability metrics for your applications. By passing the `ApplicationReferenceNumber` for an existing application you can use the validated financials from earlier [`/application/create`](#Application/Create) and [`/application/manage`](#Application/Manage) requests to get accurate serviceability outputs.\r\n \r\n In each request you can provide a list of new facilities, for which serviceability metrics will be returned. \r\n \r\n You will be required to supply the following required information:\r\n * `ApplicationReferenceNumber`: this will extract validated financials from the application object from earlier processes.\r\n * `NewFacilities`: specifics of the new debt facilities.\r\n * `ConfigurationSet`: the lending policy configuration for which you wish to calculate serviceability metrics. This will be the lender or product enumeration you have configured within Xapii\r\n\r\n If you require HEM calculations you can set the `IsHemRequired` optional parameter. This is set to `false` by default. If you set this value to `true` then you must provide the following additional values under the `ApplicationContacts` object:\r\n * `EmailAddress`\r\n * `Dependants`\r\n * `MartialStatus`\r\n * `ResidentialStatus`\r\n \r\n\r\n You also have the ability to provide additional applicant and application level values over and above the outputs from earlier financial validation processes. These are optional - we will use validated figures and configured defaults where these are not provided. The table below lists the high level optional objects for tailoring serviceability calculations.\r\n \r\n | Optional Value | Purpose |\r\n |-----|-----| \r\n | `ApplicantIncome` | Applicant-specific income values including self-employed income inputs and addbacks.|\r\n | `ApplicantDebt` | Applicant-specific liabilities including home loans and ownership percentage |\r\n | `ApplicationExpenses` | Household-specific expenses include non-discretionary expenses and HEM values |\r\n \r\n Please note: \r\n * If your applicant is self employed you will need to set the `IsSelfEmployed` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n * If your applicant has a HECS debt you will need to set the `HasHecsDebt` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n " }, "response": [] }, @@ -696,7 +696,7 @@ "getexpensesummary" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] } @@ -770,7 +770,7 @@ } ] }, - "description": "Before you can call the XAI Validate endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the XAI Validate team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" + "description": "Before you can call the Xapii endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the Xapii team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" }, "response": [] }, @@ -830,7 +830,7 @@ "create" ] }, - "description": " This endpoint allows you to create an \"application\", which is the object that holds all elements and represents a point-in-time product application from your customer. XAI Validate assigns each application a unique `ApplicationReferenceNumber` (Arn). You can use this value for subsequent calls.\r\n \r\n \r\n When you create an application you determine the data sources and data validation type you need, namely:\r\n 1. \"Detect and Position\" or \"declare and verify\": do you want XAI Validate to identify your customers' financial position and provide you with the insights or do you want XAI Validate to automate financial validation decisioning for you? If you choose a \"declare and verify\" approach you need to provide your customers' \"declared\" financials to the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.\r\n 2. your customers: you can link one or more applicants to an application. XAI Validate will combine any jointly held accounts as part of the linking process.\r\n 3. your customer data source: XAI Validate supports multiple data sources. See the table below for more information.\r\n \r\n \r\n The table below lists the parameters you need to populate based on your data validation choice above:\r\n \r\n | Function | Description |\r\n |-----|-----| \r\n | `ApplicationContacts` | These are the applicants applying for your product. XAI Validate currently supports up to two applicants.|\r\n | `ExternalDataId`| This is the reference information for your existing data aggregator. XAI Validate currently supports multiple data sources - see the table below for information.|\r\n | `ExternalApplicationReferenceNumber`| This is an application reference from your own system to allow you to easily correlate the XAI Validate `ApplicationReferenceNumber` with your own records.|\r\n | `IsActualsOnly`| This parameter is only used by those clients that require a \"declare and verify\" approach to financial assessment. By setting this boolean to `false` these customers can then call the [`/application/manage`](#/application/manage) endpoint to add their applicants' \"declared\" or \"stated\" financials. This value will default to `true` meaning XAI Validate will return your applicants' \"actual\" financial position from the data. If don't pass a value for `IsActualsOnly`, then automated assessment will be triggered when you receive a successful response. If you're passing `\"IsActualsOnly\": false` then automated assessment will wait for you provide your applicants' \"declared\" financials via the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.|\r\n \r\n XAI Validate supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your XAI Validate client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your XAI Validate application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Basiq (coming soon!) | `BSQ` | As list of your Basiq customer identifiers. | You should have a one to one linking of applicant to Basiq customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " + "description": " This endpoint allows you to create an \"application\", which is the object that holds all elements and represents a point-in-time product application from your customer. Xapii assigns each application a unique `ApplicationReferenceNumber` (Arn). You can use this value for subsequent calls.\r\n \r\n \r\n When you create an application you determine the data sources and data validation type you need, namely:\r\n 1. \"Detect and Position\" or \"declare and verify\": do you want Xapii to identify your customers' financial position and provide you with the insights or do you want Xapii to automate financial validation decisioning for you? If you choose a \"declare and verify\" approach you need to provide your customers' \"declared\" financials to the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.\r\n 2. your customers: you can link one or more applicants to an application. Xapii will combine any jointly held accounts as part of the linking process.\r\n 3. your customer data source: Xapii supports multiple data sources. See the table below for more information.\r\n \r\n \r\n The table below lists the parameters you need to populate based on your data validation choice above:\r\n \r\n | Function | Description |\r\n |-----|-----| \r\n | `ApplicationContacts` | These are the applicants applying for your product. Xapii currently supports up to two applicants.|\r\n | `ExternalDataId`| This is the reference information for your existing data aggregator. Xapii currently supports multiple data sources - see the table below for information.|\r\n | `ExternalApplicationReferenceNumber`| This is an application reference from your own system to allow you to easily correlate the Xapii `ApplicationReferenceNumber` with your own records.|\r\n | `IsActualsOnly`| This parameter is only used by those clients that require a \"declare and verify\" approach to financial assessment. By setting this boolean to `false` these customers can then call the [`/application/manage`](#/application/manage) endpoint to add their applicants' \"declared\" or \"stated\" financials. This value will default to `true` meaning Xapii will return your applicants' \"actual\" financial position from the data. If don't pass a value for `IsActualsOnly`, then automated assessment will be triggered when you receive a successful response. If you're passing `\"IsActualsOnly\": false` then automated assessment will wait for you provide your applicants' \"declared\" financials via the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.|\r\n \r\n Xapii supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your Xapii client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your Xapii application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " }, "response": [] }, @@ -887,7 +887,7 @@ "manage" ] }, - "description": " \r\n This versatile endpoint allows you to perform the following functions against an existing application:\r\n | Function | Description |\r\n |-----|-----| \r\n | Add/edit \"stated/declared\" financials against an application | This is only relevant if you require a \"declare and verify\" approach to financial assessment, and have passed the `\"IsActualsOnly\": false` parameter in your [`/application/create`](#Application/Create) request.|\r\n | Link additional data source to an application |This is useful when your applicants provide additional bank account information thorugh your data aggregator, and you need to rerun the automated assessment. Please see the table below for data source details. |\r\n | Add/edit applicants within an application (coming soon!)| Add new applicants or edit existing ones. |\r\n \r\n When you call the endpoint, automated assessment will commence once you receive a successful response. You can monitor the progress using the [`/application/getstatus`](#/application/getstatus) endpoint.\r\n \r\n Please note the assessment levels XAI Validate currently supports for providing \"stated/declared\" financials. These have been designed in line with lending best practices:\r\n \r\n | Assessment Level | Financial Types |\r\n |-----|-----|\r\n | `Application` | These are application-level financials (`DeclaredFinancialsApplication`) and currently accommodate `AssetsCash` for assessment of your applicants' deposit|\r\n | `Household` | Your applicants will belong to `Households` and the `DeclaredFinancialsHousehold` object currently supports `ExpensesMonthly` for your applicants' household's monthly expenses |\r\n | `Applicant` | These are the applicant-specific financials, which includes a `IncomeSalary` figure, a list of `IncomeRental` values, a list of `LiabilitiesHomeLoans` values, and single values for `LiabilitiesCreditCard*` and `LiabilitiesPersonalLoan*`|\r\n \r\n \r\n XAI Validate supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your XAI Validate client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your XAI Validate application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Basiq (coming soon!) | `BSQ` | As list of your Basiq customer identifiers. | You should have a one to one linking of applicant to Basiq customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " + "description": " \r\n This versatile endpoint allows you to perform the following functions against an existing application:\r\n | Function | Description |\r\n |-----|-----| \r\n | Add/edit \"stated/declared\" financials against an application | This is only relevant if you require a \"declare and verify\" approach to financial assessment, and have passed the `\"IsActualsOnly\": false` parameter in your [`/application/create`](#Application/Create) request.|\r\n | Link additional data source to an application |This is useful when your applicants provide additional bank account information thorugh your data aggregator, and you need to rerun the automated assessment. Please see the table below for data source details. |\r\n | Add/edit applicants within an application (coming soon!)| Add new applicants or edit existing ones. |\r\n \r\n When you call the endpoint, automated assessment will commence once you receive a successful response. You can monitor the progress using the [`/application/getstatus`](#/application/getstatus) endpoint.\r\n \r\n Please note the assessment levels Xapii currently supports for providing \"stated/declared\" financials. These have been designed in line with lending best practices:\r\n \r\n | Assessment Level | Financial Types |\r\n |-----|-----|\r\n | `Application` | These are application-level financials (`DeclaredFinancialsApplication`) and currently accommodate `AssetsCash` for assessment of your applicants' deposit|\r\n | `Household` | Your applicants will belong to `Households` and the `DeclaredFinancialsHousehold` object currently supports `ExpensesMonthly` for your applicants' household's monthly expenses |\r\n | `Applicant` | These are the applicant-specific financials, which includes a `IncomeSalary` figure, a list of `IncomeRental` values, a list of `LiabilitiesHomeLoans` values, and single values for `LiabilitiesCreditCard*` and `LiabilitiesPersonalLoan*`|\r\n \r\n \r\n Xapii supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your Xapii client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your Xapii application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " }, "response": [] }, @@ -933,7 +933,7 @@ "getstatus" ] }, - "description": " Retrieve the status of your automated financial assessment process. Financial validation has a diverse range of activities from retrieving provider data, normalising accounts and transactions, through to automated assessment of financial position. A `GroupId` will be returned in the response for the following endpoints, which you can use to monitor progress:\r\n - [`/application/create`](#/application/create)\r\n - [`/application/manage`](#/application/manage)\r\n \r\n We will return an overall status of the financial validation tasks. The status codes are:\r\n - `READY` - task processing has not yet started \r\n - `PROCESSING` - task processing is underway\r\n - `COMPLETED` - task processing has completed successfully\r\n - `FAILED` - a task has failed processing. XAI Validate will retry the task, so continue to monitor.\r\n - `DEAD` - oops... something's gone wrong. No further processing takes place - we'll monitor the system for these issues.\r\n " + "description": " Retrieve the status of your automated financial assessment process. Financial validation has a diverse range of activities from retrieving provider data, normalising accounts and transactions, through to automated assessment of financial position. A `GroupId` will be returned in the response for the following endpoints, which you can use to monitor progress:\r\n - [`/application/create`](#/application/create)\r\n - [`/application/manage`](#/application/manage)\r\n \r\n We will return an overall status of the financial validation tasks. The status codes are:\r\n - `READY` - task processing has not yet started \r\n - `PROCESSING` - task processing is underway\r\n - `COMPLETED` - task processing has completed successfully\r\n - `FAILED` - a task has failed processing. Xapii will retry the task, so continue to monitor.\r\n - `DEAD` - oops... something's gone wrong. No further processing takes place - we'll monitor the system for these issues.\r\n " }, "response": [] }, @@ -979,7 +979,7 @@ "getsummary" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] }, @@ -1024,7 +1024,7 @@ "getserviceability" ] }, - "description": " This endpoint allows you to get serviceability metrics for your applications. By passing the `ApplicationReferenceNumber` for an existing application you can use the validated financials from earlier [`/application/create`](#Application/Create) and [`/application/manage`](#Application/Manage) requests to get accurate serviceability outputs.\r\n \r\n In each request you can provide a list of new facilities, for which serviceability metrics will be returned. \r\n \r\n You will be required to supply the following required information:\r\n * `ApplicationReferenceNumber`: this will extract validated financials from the application object from earlier processes.\r\n * `NewFacilities`: specifics of the new debt facilities.\r\n * `ConfigurationSet`: the lending policy configuration for which you wish to calculate serviceability metrics. This will be the lender or product enumeration you have configured within XAI Validate\r\n\r\n If you require HEM calculations you can set the `IsHemRequired` optional parameter. This is set to `false` by default. If you set this value to `true` then you must provide the following additional values under the `ApplicationContacts` object:\r\n * `EmailAddress`\r\n * `Dependants`\r\n * `MartialStatus`\r\n * `ResidentialStatus`\r\n \r\n\r\n You also have the ability to provide additional applicant and application level values over and above the outputs from earlier financial validation processes. These are optional - we will use validated figures and configured defaults where these are not provided. The table below lists the high level optional objects for tailoring serviceability calculations.\r\n \r\n | Optional Value | Purpose |\r\n |-----|-----| \r\n | `ApplicantIncome` | Applicant-specific income values including self-employed income inputs and addbacks.|\r\n | `ApplicantDebt` | Applicant-specific liabilities including home loans and ownership percentage |\r\n | `ApplicationExpenses` | Household-specific expenses include non-discretionary expenses and HEM values |\r\n \r\n Please note: \r\n * If your applicant is self employed you will need to set the `IsSelfEmployed` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n * If your applicant has a HECS debt you will need to set the `HasHecsDebt` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n " + "description": " This endpoint allows you to get serviceability metrics for your applications. By passing the `ApplicationReferenceNumber` for an existing application you can use the validated financials from earlier [`/application/create`](#Application/Create) and [`/application/manage`](#Application/Manage) requests to get accurate serviceability outputs.\r\n \r\n In each request you can provide a list of new facilities, for which serviceability metrics will be returned. \r\n \r\n You will be required to supply the following required information:\r\n * `ApplicationReferenceNumber`: this will extract validated financials from the application object from earlier processes.\r\n * `NewFacilities`: specifics of the new debt facilities.\r\n * `ConfigurationSet`: the lending policy configuration for which you wish to calculate serviceability metrics. This will be the lender or product enumeration you have configured within Xapii\r\n\r\n If you require HEM calculations you can set the `IsHemRequired` optional parameter. This is set to `false` by default. If you set this value to `true` then you must provide the following additional values under the `ApplicationContacts` object:\r\n * `EmailAddress`\r\n * `Dependants`\r\n * `MartialStatus`\r\n * `ResidentialStatus`\r\n \r\n\r\n You also have the ability to provide additional applicant and application level values over and above the outputs from earlier financial validation processes. These are optional - we will use validated figures and configured defaults where these are not provided. The table below lists the high level optional objects for tailoring serviceability calculations.\r\n \r\n | Optional Value | Purpose |\r\n |-----|-----| \r\n | `ApplicantIncome` | Applicant-specific income values including self-employed income inputs and addbacks.|\r\n | `ApplicantDebt` | Applicant-specific liabilities including home loans and ownership percentage |\r\n | `ApplicationExpenses` | Household-specific expenses include non-discretionary expenses and HEM values |\r\n \r\n Please note: \r\n * If your applicant is self employed you will need to set the `IsSelfEmployed` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n * If your applicant has a HECS debt you will need to set the `HasHecsDebt` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n " }, "response": [] }, @@ -1070,7 +1070,7 @@ "getexpensesummary" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] } @@ -1149,7 +1149,7 @@ } ] }, - "description": "Before you can call the XAI Validate endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the XAI Validate team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" + "description": "Before you can call the Xapii endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the Xapii team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" }, "response": [] }, @@ -1209,7 +1209,7 @@ "create" ] }, - "description": " This endpoint allows you to create an \"application\", which is the object that holds all elements and represents a point-in-time product application from your customer. XAI Validate assigns each application a unique `ApplicationReferenceNumber` (Arn). You can use this value for subsequent calls.\r\n \r\n \r\n When you create an application you determine the data sources and data validation type you need, namely:\r\n 1. \"Detect and Position\" or \"declare and verify\": do you want XAI Validate to identify your customers' financial position and provide you with the insights or do you want XAI Validate to automate financial validation decisioning for you? If you choose a \"declare and verify\" approach you need to provide your customers' \"declared\" financials to the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.\r\n 2. your customers: you can link one or more applicants to an application. XAI Validate will combine any jointly held accounts as part of the linking process.\r\n 3. your customer data source: XAI Validate supports multiple data sources. See the table below for more information.\r\n \r\n \r\n The table below lists the parameters you need to populate based on your data validation choice above:\r\n \r\n | Function | Description |\r\n |-----|-----| \r\n | `ApplicationContacts` | These are the applicants applying for your product. XAI Validate currently supports up to two applicants.|\r\n | `ExternalDataId`| This is the reference information for your existing data aggregator. XAI Validate currently supports multiple data sources - see the table below for information.|\r\n | `ExternalApplicationReferenceNumber`| This is an application reference from your own system to allow you to easily correlate the XAI Validate `ApplicationReferenceNumber` with your own records.|\r\n | `IsActualsOnly`| This parameter is only used by those clients that require a \"declare and verify\" approach to financial assessment. By setting this boolean to `false` these customers can then call the [`/application/manage`](#/application/manage) endpoint to add their applicants' \"declared\" or \"stated\" financials. This value will default to `true` meaning XAI Validate will return your applicants' \"actual\" financial position from the data. If don't pass a value for `IsActualsOnly`, then automated assessment will be triggered when you receive a successful response. If you're passing `\"IsActualsOnly\": false` then automated assessment will wait for you provide your applicants' \"declared\" financials via the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.|\r\n \r\n XAI Validate supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your XAI Validate client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your XAI Validate application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Basiq (coming soon!) | `BSQ` | As list of your Basiq customer identifiers. | You should have a one to one linking of applicant to Basiq customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " + "description": " This endpoint allows you to create an \"application\", which is the object that holds all elements and represents a point-in-time product application from your customer. Xapii assigns each application a unique `ApplicationReferenceNumber` (Arn). You can use this value for subsequent calls.\r\n \r\n \r\n When you create an application you determine the data sources and data validation type you need, namely:\r\n 1. \"Detect and Position\" or \"declare and verify\": do you want Xapii to identify your customers' financial position and provide you with the insights or do you want Xapii to automate financial validation decisioning for you? If you choose a \"declare and verify\" approach you need to provide your customers' \"declared\" financials to the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.\r\n 2. your customers: you can link one or more applicants to an application. Xapii will combine any jointly held accounts as part of the linking process.\r\n 3. your customer data source: Xapii supports multiple data sources. See the table below for more information.\r\n \r\n \r\n The table below lists the parameters you need to populate based on your data validation choice above:\r\n \r\n | Function | Description |\r\n |-----|-----| \r\n | `ApplicationContacts` | These are the applicants applying for your product. Xapii currently supports up to two applicants.|\r\n | `ExternalDataId`| This is the reference information for your existing data aggregator. Xapii currently supports multiple data sources - see the table below for information.|\r\n | `ExternalApplicationReferenceNumber`| This is an application reference from your own system to allow you to easily correlate the Xapii `ApplicationReferenceNumber` with your own records.|\r\n | `IsActualsOnly`| This parameter is only used by those clients that require a \"declare and verify\" approach to financial assessment. By setting this boolean to `false` these customers can then call the [`/application/manage`](#/application/manage) endpoint to add their applicants' \"declared\" or \"stated\" financials. This value will default to `true` meaning Xapii will return your applicants' \"actual\" financial position from the data. If don't pass a value for `IsActualsOnly`, then automated assessment will be triggered when you receive a successful response. If you're passing `\"IsActualsOnly\": false` then automated assessment will wait for you provide your applicants' \"declared\" financials via the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.|\r\n \r\n Xapii supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your Xapii client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your Xapii application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " }, "response": [] }, @@ -1267,7 +1267,7 @@ "manage" ] }, - "description": " \r\n This versatile endpoint allows you to perform the following functions against an existing application:\r\n | Function | Description |\r\n |-----|-----| \r\n | Add/edit \"stated/declared\" financials against an application | This is only relevant if you require a \"declare and verify\" approach to financial assessment, and have passed the `\"IsActualsOnly\": false` parameter in your [`/application/create`](#Application/Create) request.|\r\n | Link additional data source to an application |This is useful when your applicants provide additional bank account information thorugh your data aggregator, and you need to rerun the automated assessment. Please see the table below for data source details. |\r\n | Add/edit applicants within an application (coming soon!)| Add new applicants or edit existing ones. |\r\n \r\n When you call the endpoint, automated assessment will commence once you receive a successful response. You can monitor the progress using the [`/application/getstatus`](#/application/getstatus) endpoint.\r\n \r\n Please note the assessment levels XAI Validate currently supports for providing \"stated/declared\" financials. These have been designed in line with lending best practices:\r\n \r\n | Assessment Level | Financial Types |\r\n |-----|-----|\r\n | `Application` | These are application-level financials (`DeclaredFinancialsApplication`) and currently accommodate `AssetsCash` for assessment of your applicants' deposit|\r\n | `Household` | Your applicants will belong to `Households` and the `DeclaredFinancialsHousehold` object currently supports `ExpensesMonthly` for your applicants' household's monthly expenses |\r\n | `Applicant` | These are the applicant-specific financials, which includes a `IncomeSalary` figure, a list of `IncomeRental` values, a list of `LiabilitiesHomeLoans` values, and single values for `LiabilitiesCreditCard*` and `LiabilitiesPersonalLoan*`|\r\n \r\n \r\n XAI Validate supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your XAI Validate client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your XAI Validate application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Basiq (coming soon!) | `BSQ` | As list of your Basiq customer identifiers. | You should have a one to one linking of applicant to Basiq customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " + "description": " \r\n This versatile endpoint allows you to perform the following functions against an existing application:\r\n | Function | Description |\r\n |-----|-----| \r\n | Add/edit \"stated/declared\" financials against an application | This is only relevant if you require a \"declare and verify\" approach to financial assessment, and have passed the `\"IsActualsOnly\": false` parameter in your [`/application/create`](#Application/Create) request.|\r\n | Link additional data source to an application |This is useful when your applicants provide additional bank account information thorugh your data aggregator, and you need to rerun the automated assessment. Please see the table below for data source details. |\r\n | Add/edit applicants within an application (coming soon!)| Add new applicants or edit existing ones. |\r\n \r\n When you call the endpoint, automated assessment will commence once you receive a successful response. You can monitor the progress using the [`/application/getstatus`](#/application/getstatus) endpoint.\r\n \r\n Please note the assessment levels Xapii currently supports for providing \"stated/declared\" financials. These have been designed in line with lending best practices:\r\n \r\n | Assessment Level | Financial Types |\r\n |-----|-----|\r\n | `Application` | These are application-level financials (`DeclaredFinancialsApplication`) and currently accommodate `AssetsCash` for assessment of your applicants' deposit|\r\n | `Household` | Your applicants will belong to `Households` and the `DeclaredFinancialsHousehold` object currently supports `ExpensesMonthly` for your applicants' household's monthly expenses |\r\n | `Applicant` | These are the applicant-specific financials, which includes a `IncomeSalary` figure, a list of `IncomeRental` values, a list of `LiabilitiesHomeLoans` values, and single values for `LiabilitiesCreditCard*` and `LiabilitiesPersonalLoan*`|\r\n \r\n \r\n Xapii supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your Xapii client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your Xapii application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " }, "response": [] }, @@ -1313,7 +1313,7 @@ "getstatus" ] }, - "description": " Retrieve the status of your automated financial assessment process. Financial validation has a diverse range of activities from retrieving provider data, normalising accounts and transactions, through to automated assessment of financial position. A `GroupId` will be returned in the response for the following endpoints, which you can use to monitor progress:\r\n - [`/application/create`](#/application/create)\r\n - [`/application/manage`](#/application/manage)\r\n \r\n We will return an overall status of the financial validation tasks. The status codes are:\r\n - `READY` - task processing has not yet started \r\n - `PROCESSING` - task processing is underway\r\n - `COMPLETED` - task processing has completed successfully\r\n - `FAILED` - a task has failed processing. XAI Validate will retry the task, so continue to monitor.\r\n - `DEAD` - oops... something's gone wrong. No further processing takes place - we'll monitor the system for these issues.\r\n " + "description": " Retrieve the status of your automated financial assessment process. Financial validation has a diverse range of activities from retrieving provider data, normalising accounts and transactions, through to automated assessment of financial position. A `GroupId` will be returned in the response for the following endpoints, which you can use to monitor progress:\r\n - [`/application/create`](#/application/create)\r\n - [`/application/manage`](#/application/manage)\r\n \r\n We will return an overall status of the financial validation tasks. The status codes are:\r\n - `READY` - task processing has not yet started \r\n - `PROCESSING` - task processing is underway\r\n - `COMPLETED` - task processing has completed successfully\r\n - `FAILED` - a task has failed processing. Xapii will retry the task, so continue to monitor.\r\n - `DEAD` - oops... something's gone wrong. No further processing takes place - we'll monitor the system for these issues.\r\n " }, "response": [] }, @@ -1359,7 +1359,7 @@ "getsummary" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] }, @@ -1405,7 +1405,7 @@ "getexpensesummary" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] }, @@ -1450,7 +1450,7 @@ "getserviceability" ] }, - "description": " This endpoint allows you to get serviceability metrics for your applications. By passing the `ApplicationReferenceNumber` for an existing application you can use the validated financials from earlier [`/application/create`](#Application/Create) and [`/application/manage`](#Application/Manage) requests to get accurate serviceability outputs.\r\n \r\n In each request you can provide a list of new facilities, for which serviceability metrics will be returned. \r\n \r\n You will be required to supply the following required information:\r\n * `ApplicationReferenceNumber`: this will extract validated financials from the application object from earlier processes.\r\n * `NewFacilities`: specifics of the new debt facilities.\r\n * `ConfigurationSet`: the lending policy configuration for which you wish to calculate serviceability metrics. This will be the lender or product enumeration you have configured within XAI Validate\r\n\r\n If you require HEM calculations you can set the `IsHemRequired` optional parameter. This is set to `false` by default. If you set this value to `true` then you must provide the following additional values under the `ApplicationContacts` object:\r\n * `EmailAddress`\r\n * `Dependants`\r\n * `MartialStatus`\r\n * `ResidentialStatus`\r\n \r\n\r\n You also have the ability to provide additional applicant and application level values over and above the outputs from earlier financial validation processes. These are optional - we will use validated figures and configured defaults where these are not provided. The table below lists the high level optional objects for tailoring serviceability calculations.\r\n \r\n | Optional Value | Purpose |\r\n |-----|-----| \r\n | `ApplicantIncome` | Applicant-specific income values including self-employed income inputs and addbacks.|\r\n | `ApplicantDebt` | Applicant-specific liabilities including home loans and ownership percentage |\r\n | `ApplicationExpenses` | Household-specific expenses include non-discretionary expenses and HEM values |\r\n \r\n Please note: \r\n * If your applicant is self employed you will need to set the `IsSelfEmployed` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n * If your applicant has a HECS debt you will need to set the `HasHecsDebt` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n " + "description": " This endpoint allows you to get serviceability metrics for your applications. By passing the `ApplicationReferenceNumber` for an existing application you can use the validated financials from earlier [`/application/create`](#Application/Create) and [`/application/manage`](#Application/Manage) requests to get accurate serviceability outputs.\r\n \r\n In each request you can provide a list of new facilities, for which serviceability metrics will be returned. \r\n \r\n You will be required to supply the following required information:\r\n * `ApplicationReferenceNumber`: this will extract validated financials from the application object from earlier processes.\r\n * `NewFacilities`: specifics of the new debt facilities.\r\n * `ConfigurationSet`: the lending policy configuration for which you wish to calculate serviceability metrics. This will be the lender or product enumeration you have configured within Xapii\r\n\r\n If you require HEM calculations you can set the `IsHemRequired` optional parameter. This is set to `false` by default. If you set this value to `true` then you must provide the following additional values under the `ApplicationContacts` object:\r\n * `EmailAddress`\r\n * `Dependants`\r\n * `MartialStatus`\r\n * `ResidentialStatus`\r\n \r\n\r\n You also have the ability to provide additional applicant and application level values over and above the outputs from earlier financial validation processes. These are optional - we will use validated figures and configured defaults where these are not provided. The table below lists the high level optional objects for tailoring serviceability calculations.\r\n \r\n | Optional Value | Purpose |\r\n |-----|-----| \r\n | `ApplicantIncome` | Applicant-specific income values including self-employed income inputs and addbacks.|\r\n | `ApplicantDebt` | Applicant-specific liabilities including home loans and ownership percentage |\r\n | `ApplicationExpenses` | Household-specific expenses include non-discretionary expenses and HEM values |\r\n \r\n Please note: \r\n * If your applicant is self employed you will need to set the `IsSelfEmployed` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n * If your applicant has a HECS debt you will need to set the `HasHecsDebt` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n " }, "response": [] } @@ -1524,7 +1524,7 @@ } ] }, - "description": "Before you can call the XAI Validate endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the XAI Validate team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" + "description": "Before you can call the Xapii endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the Xapii team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" }, "response": [] }, @@ -1584,7 +1584,7 @@ "create" ] }, - "description": " This endpoint allows you to create an \"application\", which is the object that holds all elements and represents a point-in-time product application from your customer. XAI Validate assigns each application a unique `ApplicationReferenceNumber` (Arn). You can use this value for subsequent calls.\r\n \r\n \r\n When you create an application you determine the data sources and data validation type you need, namely:\r\n 1. \"Detect and Position\" or \"declare and verify\": do you want XAI Validate to identify your customers' financial position and provide you with the insights or do you want XAI Validate to automate financial validation decisioning for you? If you choose a \"declare and verify\" approach you need to provide your customers' \"declared\" financials to the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.\r\n 2. your customers: you can link one or more applicants to an application. XAI Validate will combine any jointly held accounts as part of the linking process.\r\n 3. your customer data source: XAI Validate supports multiple data sources. See the table below for more information.\r\n \r\n \r\n The table below lists the parameters you need to populate based on your data validation choice above:\r\n \r\n | Function | Description |\r\n |-----|-----| \r\n | `ApplicationContacts` | These are the applicants applying for your product. XAI Validate currently supports up to two applicants.|\r\n | `ExternalDataId`| This is the reference information for your existing data aggregator. XAI Validate currently supports multiple data sources - see the table below for information.|\r\n | `ExternalApplicationReferenceNumber`| This is an application reference from your own system to allow you to easily correlate the XAI Validate `ApplicationReferenceNumber` with your own records.|\r\n | `IsActualsOnly`| This parameter is only used by those clients that require a \"declare and verify\" approach to financial assessment. By setting this boolean to `false` these customers can then call the [`/application/manage`](#/application/manage) endpoint to add their applicants' \"declared\" or \"stated\" financials. This value will default to `true` meaning XAI Validate will return your applicants' \"actual\" financial position from the data. If don't pass a value for `IsActualsOnly`, then automated assessment will be triggered when you receive a successful response. If you're passing `\"IsActualsOnly\": false` then automated assessment will wait for you provide your applicants' \"declared\" financials via the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.|\r\n \r\n XAI Validate supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your XAI Validate client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your XAI Validate application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Basiq (coming soon!) | `BSQ` | As list of your Basiq customer identifiers. | You should have a one to one linking of applicant to Basiq customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " + "description": " This endpoint allows you to create an \"application\", which is the object that holds all elements and represents a point-in-time product application from your customer. Xapii assigns each application a unique `ApplicationReferenceNumber` (Arn). You can use this value for subsequent calls.\r\n \r\n \r\n When you create an application you determine the data sources and data validation type you need, namely:\r\n 1. \"Detect and Position\" or \"declare and verify\": do you want Xapii to identify your customers' financial position and provide you with the insights or do you want Xapii to automate financial validation decisioning for you? If you choose a \"declare and verify\" approach you need to provide your customers' \"declared\" financials to the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.\r\n 2. your customers: you can link one or more applicants to an application. Xapii will combine any jointly held accounts as part of the linking process.\r\n 3. your customer data source: Xapii supports multiple data sources. See the table below for more information.\r\n \r\n \r\n The table below lists the parameters you need to populate based on your data validation choice above:\r\n \r\n | Function | Description |\r\n |-----|-----| \r\n | `ApplicationContacts` | These are the applicants applying for your product. Xapii currently supports up to two applicants.|\r\n | `ExternalDataId`| This is the reference information for your existing data aggregator. Xapii currently supports multiple data sources - see the table below for information.|\r\n | `ExternalApplicationReferenceNumber`| This is an application reference from your own system to allow you to easily correlate the Xapii `ApplicationReferenceNumber` with your own records.|\r\n | `IsActualsOnly`| This parameter is only used by those clients that require a \"declare and verify\" approach to financial assessment. By setting this boolean to `false` these customers can then call the [`/application/manage`](#/application/manage) endpoint to add their applicants' \"declared\" or \"stated\" financials. This value will default to `true` meaning Xapii will return your applicants' \"actual\" financial position from the data. If don't pass a value for `IsActualsOnly`, then automated assessment will be triggered when you receive a successful response. If you're passing `\"IsActualsOnly\": false` then automated assessment will wait for you provide your applicants' \"declared\" financials via the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.|\r\n \r\n Xapii supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your Xapii client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your Xapii application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " }, "response": [] }, @@ -1642,7 +1642,7 @@ "manage" ] }, - "description": " \r\n This versatile endpoint allows you to perform the following functions against an existing application:\r\n | Function | Description |\r\n |-----|-----| \r\n | Add/edit \"stated/declared\" financials against an application | This is only relevant if you require a \"declare and verify\" approach to financial assessment, and have passed the `\"IsActualsOnly\": false` parameter in your [`/application/create`](#Application/Create) request.|\r\n | Link additional data source to an application |This is useful when your applicants provide additional bank account information thorugh your data aggregator, and you need to rerun the automated assessment. Please see the table below for data source details. |\r\n | Add/edit applicants within an application (coming soon!)| Add new applicants or edit existing ones. |\r\n \r\n When you call the endpoint, automated assessment will commence once you receive a successful response. You can monitor the progress using the [`/application/getstatus`](#/application/getstatus) endpoint.\r\n \r\n Please note the assessment levels XAI Validate currently supports for providing \"stated/declared\" financials. These have been designed in line with lending best practices:\r\n \r\n | Assessment Level | Financial Types |\r\n |-----|-----|\r\n | `Application` | These are application-level financials (`DeclaredFinancialsApplication`) and currently accommodate `AssetsCash` for assessment of your applicants' deposit|\r\n | `Household` | Your applicants will belong to `Households` and the `DeclaredFinancialsHousehold` object currently supports `ExpensesMonthly` for your applicants' household's monthly expenses |\r\n | `Applicant` | These are the applicant-specific financials, which includes a `IncomeSalary` figure, a list of `IncomeRental` values, a list of `LiabilitiesHomeLoans` values, and single values for `LiabilitiesCreditCard*` and `LiabilitiesPersonalLoan*`|\r\n \r\n \r\n XAI Validate supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your XAI Validate client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your XAI Validate application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Basiq (coming soon!) | `BSQ` | As list of your Basiq customer identifiers. | You should have a one to one linking of applicant to Basiq customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " + "description": " \r\n This versatile endpoint allows you to perform the following functions against an existing application:\r\n | Function | Description |\r\n |-----|-----| \r\n | Add/edit \"stated/declared\" financials against an application | This is only relevant if you require a \"declare and verify\" approach to financial assessment, and have passed the `\"IsActualsOnly\": false` parameter in your [`/application/create`](#Application/Create) request.|\r\n | Link additional data source to an application |This is useful when your applicants provide additional bank account information thorugh your data aggregator, and you need to rerun the automated assessment. Please see the table below for data source details. |\r\n | Add/edit applicants within an application (coming soon!)| Add new applicants or edit existing ones. |\r\n \r\n When you call the endpoint, automated assessment will commence once you receive a successful response. You can monitor the progress using the [`/application/getstatus`](#/application/getstatus) endpoint.\r\n \r\n Please note the assessment levels Xapii currently supports for providing \"stated/declared\" financials. These have been designed in line with lending best practices:\r\n \r\n | Assessment Level | Financial Types |\r\n |-----|-----|\r\n | `Application` | These are application-level financials (`DeclaredFinancialsApplication`) and currently accommodate `AssetsCash` for assessment of your applicants' deposit|\r\n | `Household` | Your applicants will belong to `Households` and the `DeclaredFinancialsHousehold` object currently supports `ExpensesMonthly` for your applicants' household's monthly expenses |\r\n | `Applicant` | These are the applicant-specific financials, which includes a `IncomeSalary` figure, a list of `IncomeRental` values, a list of `LiabilitiesHomeLoans` values, and single values for `LiabilitiesCreditCard*` and `LiabilitiesPersonalLoan*`|\r\n \r\n \r\n Xapii supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your Xapii client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your Xapii application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " }, "response": [] }, @@ -1688,7 +1688,7 @@ "getstatus" ] }, - "description": " Retrieve the status of your automated financial assessment process. Financial validation has a diverse range of activities from retrieving provider data, normalising accounts and transactions, through to automated assessment of financial position. A `GroupId` will be returned in the response for the following endpoints, which you can use to monitor progress:\r\n - [`/application/create`](#/application/create)\r\n - [`/application/manage`](#/application/manage)\r\n \r\n We will return an overall status of the financial validation tasks. The status codes are:\r\n - `READY` - task processing has not yet started \r\n - `PROCESSING` - task processing is underway\r\n - `COMPLETED` - task processing has completed successfully\r\n - `FAILED` - a task has failed processing. XAI Validate will retry the task, so continue to monitor.\r\n - `DEAD` - oops... something's gone wrong. No further processing takes place - we'll monitor the system for these issues.\r\n " + "description": " Retrieve the status of your automated financial assessment process. Financial validation has a diverse range of activities from retrieving provider data, normalising accounts and transactions, through to automated assessment of financial position. A `GroupId` will be returned in the response for the following endpoints, which you can use to monitor progress:\r\n - [`/application/create`](#/application/create)\r\n - [`/application/manage`](#/application/manage)\r\n \r\n We will return an overall status of the financial validation tasks. The status codes are:\r\n - `READY` - task processing has not yet started \r\n - `PROCESSING` - task processing is underway\r\n - `COMPLETED` - task processing has completed successfully\r\n - `FAILED` - a task has failed processing. Xapii will retry the task, so continue to monitor.\r\n - `DEAD` - oops... something's gone wrong. No further processing takes place - we'll monitor the system for these issues.\r\n " }, "response": [] }, @@ -1734,7 +1734,7 @@ "getsummary" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] }, @@ -1780,7 +1780,7 @@ "getexpensesummary" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] }, @@ -1825,7 +1825,7 @@ "getserviceability" ] }, - "description": " This endpoint allows you to get serviceability metrics for your applications. By passing the `ApplicationReferenceNumber` for an existing application you can use the validated financials from earlier [`/application/create`](#Application/Create) and [`/application/manage`](#Application/Manage) requests to get accurate serviceability outputs.\r\n \r\n In each request you can provide a list of new facilities, for which serviceability metrics will be returned. \r\n \r\n You will be required to supply the following required information:\r\n * `ApplicationReferenceNumber`: this will extract validated financials from the application object from earlier processes.\r\n * `NewFacilities`: specifics of the new debt facilities.\r\n * `ConfigurationSet`: the lending policy configuration for which you wish to calculate serviceability metrics. This will be the lender or product enumeration you have configured within XAI Validate\r\n\r\n If you require HEM calculations you can set the `IsHemRequired` optional parameter. This is set to `false` by default. If you set this value to `true` then you must provide the following additional values under the `ApplicationContacts` object:\r\n * `EmailAddress`\r\n * `Dependants`\r\n * `MartialStatus`\r\n * `ResidentialStatus`\r\n \r\n\r\n You also have the ability to provide additional applicant and application level values over and above the outputs from earlier financial validation processes. These are optional - we will use validated figures and configured defaults where these are not provided. The table below lists the high level optional objects for tailoring serviceability calculations.\r\n \r\n | Optional Value | Purpose |\r\n |-----|-----| \r\n | `ApplicantIncome` | Applicant-specific income values including self-employed income inputs and addbacks.|\r\n | `ApplicantDebt` | Applicant-specific liabilities including home loans and ownership percentage |\r\n | `ApplicationExpenses` | Household-specific expenses include non-discretionary expenses and HEM values |\r\n \r\n Please note: \r\n * If your applicant is self employed you will need to set the `IsSelfEmployed` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n * If your applicant has a HECS debt you will need to set the `HasHecsDebt` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n " + "description": " This endpoint allows you to get serviceability metrics for your applications. By passing the `ApplicationReferenceNumber` for an existing application you can use the validated financials from earlier [`/application/create`](#Application/Create) and [`/application/manage`](#Application/Manage) requests to get accurate serviceability outputs.\r\n \r\n In each request you can provide a list of new facilities, for which serviceability metrics will be returned. \r\n \r\n You will be required to supply the following required information:\r\n * `ApplicationReferenceNumber`: this will extract validated financials from the application object from earlier processes.\r\n * `NewFacilities`: specifics of the new debt facilities.\r\n * `ConfigurationSet`: the lending policy configuration for which you wish to calculate serviceability metrics. This will be the lender or product enumeration you have configured within Xapii\r\n\r\n If you require HEM calculations you can set the `IsHemRequired` optional parameter. This is set to `false` by default. If you set this value to `true` then you must provide the following additional values under the `ApplicationContacts` object:\r\n * `EmailAddress`\r\n * `Dependants`\r\n * `MartialStatus`\r\n * `ResidentialStatus`\r\n \r\n\r\n You also have the ability to provide additional applicant and application level values over and above the outputs from earlier financial validation processes. These are optional - we will use validated figures and configured defaults where these are not provided. The table below lists the high level optional objects for tailoring serviceability calculations.\r\n \r\n | Optional Value | Purpose |\r\n |-----|-----| \r\n | `ApplicantIncome` | Applicant-specific income values including self-employed income inputs and addbacks.|\r\n | `ApplicantDebt` | Applicant-specific liabilities including home loans and ownership percentage |\r\n | `ApplicationExpenses` | Household-specific expenses include non-discretionary expenses and HEM values |\r\n \r\n Please note: \r\n * If your applicant is self employed you will need to set the `IsSelfEmployed` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n * If your applicant has a HECS debt you will need to set the `HasHecsDebt` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n " }, "response": [] } @@ -1899,7 +1899,7 @@ } ] }, - "description": "Before you can call the XAI Validate endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the XAI Validate team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" + "description": "Before you can call the Xapii endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the Xapii team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" }, "response": [] }, @@ -1961,7 +1961,7 @@ "create" ] }, - "description": " This endpoint allows you to create an \"application\", which is the object that holds all elements and represents a point-in-time product application from your customer. XAI Validate assigns each application a unique `ApplicationReferenceNumber` (Arn). You can use this value for subsequent calls.\r\n \r\n \r\n When you create an application you determine the data sources and data validation type you need, namely:\r\n 1. \"Detect and Position\" or \"declare and verify\": do you want XAI Validate to identify your customers' financial position and provide you with the insights or do you want XAI Validate to automate financial validation decisioning for you? If you choose a \"declare and verify\" approach you need to provide your customers' \"declared\" financials to the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.\r\n 2. your customers: you can link one or more applicants to an application. XAI Validate will combine any jointly held accounts as part of the linking process.\r\n 3. your customer data source: XAI Validate supports multiple data sources. See the table below for more information.\r\n \r\n \r\n The table below lists the parameters you need to populate based on your data validation choice above:\r\n \r\n | Function | Description |\r\n |-----|-----| \r\n | `ApplicationContacts` | These are the applicants applying for your product. XAI Validate currently supports up to two applicants.|\r\n | `ExternalDataId`| This is the reference information for your existing data aggregator. XAI Validate currently supports multiple data sources - see the table below for information.|\r\n | `ExternalApplicationReferenceNumber`| This is an application reference from your own system to allow you to easily correlate the XAI Validate `ApplicationReferenceNumber` with your own records.|\r\n | `IsActualsOnly`| This parameter is only used by those clients that require a \"declare and verify\" approach to financial assessment. By setting this boolean to `false` these customers can then call the [`/application/manage`](#/application/manage) endpoint to add their applicants' \"declared\" or \"stated\" financials. This value will default to `true` meaning XAI Validate will return your applicants' \"actual\" financial position from the data. If don't pass a value for `IsActualsOnly`, then automated assessment will be triggered when you receive a successful response. If you're passing `\"IsActualsOnly\": false` then automated assessment will wait for you provide your applicants' \"declared\" financials via the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.|\r\n \r\n XAI Validate supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your XAI Validate client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your XAI Validate application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Basiq (coming soon!) | `BSQ` | As list of your Basiq customer identifiers. | You should have a one to one linking of applicant to Basiq customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " + "description": " This endpoint allows you to create an \"application\", which is the object that holds all elements and represents a point-in-time product application from your customer. Xapii assigns each application a unique `ApplicationReferenceNumber` (Arn). You can use this value for subsequent calls.\r\n \r\n \r\n When you create an application you determine the data sources and data validation type you need, namely:\r\n 1. \"Detect and Position\" or \"declare and verify\": do you want Xapii to identify your customers' financial position and provide you with the insights or do you want Xapii to automate financial validation decisioning for you? If you choose a \"declare and verify\" approach you need to provide your customers' \"declared\" financials to the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.\r\n 2. your customers: you can link one or more applicants to an application. Xapii will combine any jointly held accounts as part of the linking process.\r\n 3. your customer data source: Xapii supports multiple data sources. See the table below for more information.\r\n \r\n \r\n The table below lists the parameters you need to populate based on your data validation choice above:\r\n \r\n | Function | Description |\r\n |-----|-----| \r\n | `ApplicationContacts` | These are the applicants applying for your product. Xapii currently supports up to two applicants.|\r\n | `ExternalDataId`| This is the reference information for your existing data aggregator. Xapii currently supports multiple data sources - see the table below for information.|\r\n | `ExternalApplicationReferenceNumber`| This is an application reference from your own system to allow you to easily correlate the Xapii `ApplicationReferenceNumber` with your own records.|\r\n | `IsActualsOnly`| This parameter is only used by those clients that require a \"declare and verify\" approach to financial assessment. By setting this boolean to `false` these customers can then call the [`/application/manage`](#/application/manage) endpoint to add their applicants' \"declared\" or \"stated\" financials. This value will default to `true` meaning Xapii will return your applicants' \"actual\" financial position from the data. If don't pass a value for `IsActualsOnly`, then automated assessment will be triggered when you receive a successful response. If you're passing `\"IsActualsOnly\": false` then automated assessment will wait for you provide your applicants' \"declared\" financials via the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.|\r\n \r\n Xapii supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your Xapii client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your Xapii application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " }, "response": [] }, @@ -2007,7 +2007,7 @@ "getstatus" ] }, - "description": " Retrieve the status of your automated financial assessment process. Financial validation has a diverse range of activities from retrieving provider data, normalising accounts and transactions, through to automated assessment of financial position. A `GroupId` will be returned in the response for the following endpoints, which you can use to monitor progress:\r\n - [`/application/create`](#/application/create)\r\n - [`/application/manage`](#/application/manage)\r\n \r\n We will return an overall status of the financial validation tasks. The status codes are:\r\n - `READY` - task processing has not yet started \r\n - `PROCESSING` - task processing is underway\r\n - `COMPLETED` - task processing has completed successfully\r\n - `FAILED` - a task has failed processing. XAI Validate will retry the task, so continue to monitor.\r\n - `DEAD` - oops... something's gone wrong. No further processing takes place - we'll monitor the system for these issues.\r\n " + "description": " Retrieve the status of your automated financial assessment process. Financial validation has a diverse range of activities from retrieving provider data, normalising accounts and transactions, through to automated assessment of financial position. A `GroupId` will be returned in the response for the following endpoints, which you can use to monitor progress:\r\n - [`/application/create`](#/application/create)\r\n - [`/application/manage`](#/application/manage)\r\n \r\n We will return an overall status of the financial validation tasks. The status codes are:\r\n - `READY` - task processing has not yet started \r\n - `PROCESSING` - task processing is underway\r\n - `COMPLETED` - task processing has completed successfully\r\n - `FAILED` - a task has failed processing. Xapii will retry the task, so continue to monitor.\r\n - `DEAD` - oops... something's gone wrong. No further processing takes place - we'll monitor the system for these issues.\r\n " }, "response": [] }, @@ -2053,7 +2053,7 @@ "getsummary" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] }, @@ -2099,7 +2099,7 @@ "getexpensesummary" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] }, @@ -2144,7 +2144,7 @@ "getserviceability" ] }, - "description": " This endpoint allows you to get serviceability metrics for your applications. By passing the `ApplicationReferenceNumber` for an existing application you can use the validated financials from earlier [`/application/create`](#Application/Create) and [`/application/manage`](#Application/Manage) requests to get accurate serviceability outputs.\r\n \r\n In each request you can provide a list of new facilities, for which serviceability metrics will be returned. \r\n \r\n You will be required to supply the following required information:\r\n * `ApplicationReferenceNumber`: this will extract validated financials from the application object from earlier processes.\r\n * `NewFacilities`: specifics of the new debt facilities.\r\n * `ConfigurationSet`: the lending policy configuration for which you wish to calculate serviceability metrics. This will be the lender or product enumeration you have configured within XAI Validate\r\n\r\n If you require HEM calculations you can set the `IsHemRequired` optional parameter. This is set to `false` by default. If you set this value to `true` then you must provide the following additional values under the `ApplicationContacts` object:\r\n * `EmailAddress`\r\n * `Dependants`\r\n * `MartialStatus`\r\n * `ResidentialStatus`\r\n \r\n\r\n You also have the ability to provide additional applicant and application level values over and above the outputs from earlier financial validation processes. These are optional - we will use validated figures and configured defaults where these are not provided. The table below lists the high level optional objects for tailoring serviceability calculations.\r\n \r\n | Optional Value | Purpose |\r\n |-----|-----| \r\n | `ApplicantIncome` | Applicant-specific income values including self-employed income inputs and addbacks.|\r\n | `ApplicantDebt` | Applicant-specific liabilities including home loans and ownership percentage |\r\n | `ApplicationExpenses` | Household-specific expenses include non-discretionary expenses and HEM values |\r\n \r\n Please note: \r\n * If your applicant is self employed you will need to set the `IsSelfEmployed` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n * If your applicant has a HECS debt you will need to set the `HasHecsDebt` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n " + "description": " This endpoint allows you to get serviceability metrics for your applications. By passing the `ApplicationReferenceNumber` for an existing application you can use the validated financials from earlier [`/application/create`](#Application/Create) and [`/application/manage`](#Application/Manage) requests to get accurate serviceability outputs.\r\n \r\n In each request you can provide a list of new facilities, for which serviceability metrics will be returned. \r\n \r\n You will be required to supply the following required information:\r\n * `ApplicationReferenceNumber`: this will extract validated financials from the application object from earlier processes.\r\n * `NewFacilities`: specifics of the new debt facilities.\r\n * `ConfigurationSet`: the lending policy configuration for which you wish to calculate serviceability metrics. This will be the lender or product enumeration you have configured within Xapii\r\n\r\n If you require HEM calculations you can set the `IsHemRequired` optional parameter. This is set to `false` by default. If you set this value to `true` then you must provide the following additional values under the `ApplicationContacts` object:\r\n * `EmailAddress`\r\n * `Dependants`\r\n * `MartialStatus`\r\n * `ResidentialStatus`\r\n \r\n\r\n You also have the ability to provide additional applicant and application level values over and above the outputs from earlier financial validation processes. These are optional - we will use validated figures and configured defaults where these are not provided. The table below lists the high level optional objects for tailoring serviceability calculations.\r\n \r\n | Optional Value | Purpose |\r\n |-----|-----| \r\n | `ApplicantIncome` | Applicant-specific income values including self-employed income inputs and addbacks.|\r\n | `ApplicantDebt` | Applicant-specific liabilities including home loans and ownership percentage |\r\n | `ApplicationExpenses` | Household-specific expenses include non-discretionary expenses and HEM values |\r\n \r\n Please note: \r\n * If your applicant is self employed you will need to set the `IsSelfEmployed` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n * If your applicant has a HECS debt you will need to set the `HasHecsDebt` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n " }, "response": [] } @@ -2223,7 +2223,7 @@ } ] }, - "description": "Before you can call the XAI Validate endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the XAI Validate team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" + "description": "Before you can call the Xapii endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the Xapii team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" }, "response": [] }, @@ -2285,7 +2285,7 @@ "create" ] }, - "description": " This endpoint allows you to create an \"application\", which is the object that holds all elements and represents a point-in-time product application from your customer. XAI Validate assigns each application a unique `ApplicationReferenceNumber` (Arn). You can use this value for subsequent calls.\r\n \r\n \r\n When you create an application you determine the data sources and data validation type you need, namely:\r\n 1. \"Detect and Position\" or \"declare and verify\": do you want XAI Validate to identify your customers' financial position and provide you with the insights or do you want XAI Validate to automate financial validation decisioning for you? If you choose a \"declare and verify\" approach you need to provide your customers' \"declared\" financials to the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.\r\n 2. your customers: you can link one or more applicants to an application. XAI Validate will combine any jointly held accounts as part of the linking process.\r\n 3. your customer data source: XAI Validate supports multiple data sources. See the table below for more information.\r\n \r\n \r\n The table below lists the parameters you need to populate based on your data validation choice above:\r\n \r\n | Function | Description |\r\n |-----|-----| \r\n | `ApplicationContacts` | These are the applicants applying for your product. XAI Validate currently supports up to two applicants.|\r\n | `ExternalDataId`| This is the reference information for your existing data aggregator. XAI Validate currently supports multiple data sources - see the table below for information.|\r\n | `ExternalApplicationReferenceNumber`| This is an application reference from your own system to allow you to easily correlate the XAI Validate `ApplicationReferenceNumber` with your own records.|\r\n | `IsActualsOnly`| This parameter is only used by those clients that require a \"declare and verify\" approach to financial assessment. By setting this boolean to `false` these customers can then call the [`/application/manage`](#/application/manage) endpoint to add their applicants' \"declared\" or \"stated\" financials. This value will default to `true` meaning XAI Validate will return your applicants' \"actual\" financial position from the data. If don't pass a value for `IsActualsOnly`, then automated assessment will be triggered when you receive a successful response. If you're passing `\"IsActualsOnly\": false` then automated assessment will wait for you provide your applicants' \"declared\" financials via the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.|\r\n \r\n XAI Validate supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your XAI Validate client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your XAI Validate application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Basiq (coming soon!) | `BSQ` | As list of your Basiq customer identifiers. | You should have a one to one linking of applicant to Basiq customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " + "description": " This endpoint allows you to create an \"application\", which is the object that holds all elements and represents a point-in-time product application from your customer. Xapii assigns each application a unique `ApplicationReferenceNumber` (Arn). You can use this value for subsequent calls.\r\n \r\n \r\n When you create an application you determine the data sources and data validation type you need, namely:\r\n 1. \"Detect and Position\" or \"declare and verify\": do you want Xapii to identify your customers' financial position and provide you with the insights or do you want Xapii to automate financial validation decisioning for you? If you choose a \"declare and verify\" approach you need to provide your customers' \"declared\" financials to the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.\r\n 2. your customers: you can link one or more applicants to an application. Xapii will combine any jointly held accounts as part of the linking process.\r\n 3. your customer data source: Xapii supports multiple data sources. See the table below for more information.\r\n \r\n \r\n The table below lists the parameters you need to populate based on your data validation choice above:\r\n \r\n | Function | Description |\r\n |-----|-----| \r\n | `ApplicationContacts` | These are the applicants applying for your product. Xapii currently supports up to two applicants.|\r\n | `ExternalDataId`| This is the reference information for your existing data aggregator. Xapii currently supports multiple data sources - see the table below for information.|\r\n | `ExternalApplicationReferenceNumber`| This is an application reference from your own system to allow you to easily correlate the Xapii `ApplicationReferenceNumber` with your own records.|\r\n | `IsActualsOnly`| This parameter is only used by those clients that require a \"declare and verify\" approach to financial assessment. By setting this boolean to `false` these customers can then call the [`/application/manage`](#/application/manage) endpoint to add their applicants' \"declared\" or \"stated\" financials. This value will default to `true` meaning Xapii will return your applicants' \"actual\" financial position from the data. If don't pass a value for `IsActualsOnly`, then automated assessment will be triggered when you receive a successful response. If you're passing `\"IsActualsOnly\": false` then automated assessment will wait for you provide your applicants' \"declared\" financials via the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.|\r\n \r\n Xapii supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your Xapii client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your Xapii application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " }, "response": [] }, @@ -2343,7 +2343,7 @@ "manage" ] }, - "description": " \r\n This versatile endpoint allows you to perform the following functions against an existing application:\r\n | Function | Description |\r\n |-----|-----| \r\n | Add/edit \"stated/declared\" financials against an application | This is only relevant if you require a \"declare and verify\" approach to financial assessment, and have passed the `\"IsActualsOnly\": false` parameter in your [`/application/create`](#Application/Create) request.|\r\n | Link additional data source to an application |This is useful when your applicants provide additional bank account information thorugh your data aggregator, and you need to rerun the automated assessment. Please see the table below for data source details. |\r\n | Add/edit applicants within an application (coming soon!)| Add new applicants or edit existing ones. |\r\n \r\n When you call the endpoint, automated assessment will commence once you receive a successful response. You can monitor the progress using the [`/application/getstatus`](#/application/getstatus) endpoint.\r\n \r\n Please note the assessment levels XAI Validate currently supports for providing \"stated/declared\" financials. These have been designed in line with lending best practices:\r\n \r\n | Assessment Level | Financial Types |\r\n |-----|-----|\r\n | `Application` | These are application-level financials (`DeclaredFinancialsApplication`) and currently accommodate `AssetsCash` for assessment of your applicants' deposit|\r\n | `Household` | Your applicants will belong to `Households` and the `DeclaredFinancialsHousehold` object currently supports `ExpensesMonthly` for your applicants' household's monthly expenses |\r\n | `Applicant` | These are the applicant-specific financials, which includes a `IncomeSalary` figure, a list of `IncomeRental` values, a list of `LiabilitiesHomeLoans` values, and single values for `LiabilitiesCreditCard*` and `LiabilitiesPersonalLoan*`|\r\n \r\n \r\n XAI Validate supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your XAI Validate client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your XAI Validate application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Basiq (coming soon!) | `BSQ` | As list of your Basiq customer identifiers. | You should have a one to one linking of applicant to Basiq customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " + "description": " \r\n This versatile endpoint allows you to perform the following functions against an existing application:\r\n | Function | Description |\r\n |-----|-----| \r\n | Add/edit \"stated/declared\" financials against an application | This is only relevant if you require a \"declare and verify\" approach to financial assessment, and have passed the `\"IsActualsOnly\": false` parameter in your [`/application/create`](#Application/Create) request.|\r\n | Link additional data source to an application |This is useful when your applicants provide additional bank account information thorugh your data aggregator, and you need to rerun the automated assessment. Please see the table below for data source details. |\r\n | Add/edit applicants within an application (coming soon!)| Add new applicants or edit existing ones. |\r\n \r\n When you call the endpoint, automated assessment will commence once you receive a successful response. You can monitor the progress using the [`/application/getstatus`](#/application/getstatus) endpoint.\r\n \r\n Please note the assessment levels Xapii currently supports for providing \"stated/declared\" financials. These have been designed in line with lending best practices:\r\n \r\n | Assessment Level | Financial Types |\r\n |-----|-----|\r\n | `Application` | These are application-level financials (`DeclaredFinancialsApplication`) and currently accommodate `AssetsCash` for assessment of your applicants' deposit|\r\n | `Household` | Your applicants will belong to `Households` and the `DeclaredFinancialsHousehold` object currently supports `ExpensesMonthly` for your applicants' household's monthly expenses |\r\n | `Applicant` | These are the applicant-specific financials, which includes a `IncomeSalary` figure, a list of `IncomeRental` values, a list of `LiabilitiesHomeLoans` values, and single values for `LiabilitiesCreditCard*` and `LiabilitiesPersonalLoan*`|\r\n \r\n \r\n Xapii supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your Xapii client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your Xapii application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " }, "response": [] }, @@ -2500,7 +2500,7 @@ "getstatus" ] }, - "description": " Retrieve the status of your automated financial assessment process. Financial validation has a diverse range of activities from retrieving provider data, normalising accounts and transactions, through to automated assessment of financial position. A `GroupId` will be returned in the response for the following endpoints, which you can use to monitor progress:\r\n - [`/application/create`](#/application/create)\r\n - [`/application/manage`](#/application/manage)\r\n \r\n We will return an overall status of the financial validation tasks. The status codes are:\r\n - `READY` - task processing has not yet started \r\n - `PROCESSING` - task processing is underway\r\n - `COMPLETED` - task processing has completed successfully\r\n - `FAILED` - a task has failed processing. XAI Validate will retry the task, so continue to monitor.\r\n - `DEAD` - oops... something's gone wrong. No further processing takes place - we'll monitor the system for these issues.\r\n " + "description": " Retrieve the status of your automated financial assessment process. Financial validation has a diverse range of activities from retrieving provider data, normalising accounts and transactions, through to automated assessment of financial position. A `GroupId` will be returned in the response for the following endpoints, which you can use to monitor progress:\r\n - [`/application/create`](#/application/create)\r\n - [`/application/manage`](#/application/manage)\r\n \r\n We will return an overall status of the financial validation tasks. The status codes are:\r\n - `READY` - task processing has not yet started \r\n - `PROCESSING` - task processing is underway\r\n - `COMPLETED` - task processing has completed successfully\r\n - `FAILED` - a task has failed processing. Xapii will retry the task, so continue to monitor.\r\n - `DEAD` - oops... something's gone wrong. No further processing takes place - we'll monitor the system for these issues.\r\n " }, "response": [] }, @@ -2546,7 +2546,7 @@ "getsummary" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] }, @@ -2592,7 +2592,7 @@ "getexpensesummary" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] }, @@ -2637,7 +2637,7 @@ "getserviceability" ] }, - "description": " This endpoint allows you to get serviceability metrics for your applications. By passing the `ApplicationReferenceNumber` for an existing application you can use the validated financials from earlier [`/application/create`](#Application/Create) and [`/application/manage`](#Application/Manage) requests to get accurate serviceability outputs.\r\n \r\n In each request you can provide a list of new facilities, for which serviceability metrics will be returned. \r\n \r\n You will be required to supply the following required information:\r\n * `ApplicationReferenceNumber`: this will extract validated financials from the application object from earlier processes.\r\n * `NewFacilities`: specifics of the new debt facilities.\r\n * `ConfigurationSet`: the lending policy configuration for which you wish to calculate serviceability metrics. This will be the lender or product enumeration you have configured within XAI Validate\r\n\r\n If you require HEM calculations you can set the `IsHemRequired` optional parameter. This is set to `false` by default. If you set this value to `true` then you must provide the following additional values under the `ApplicationContacts` object:\r\n * `EmailAddress`\r\n * `Dependants`\r\n * `MartialStatus`\r\n * `ResidentialStatus`\r\n \r\n\r\n You also have the ability to provide additional applicant and application level values over and above the outputs from earlier financial validation processes. These are optional - we will use validated figures and configured defaults where these are not provided. The table below lists the high level optional objects for tailoring serviceability calculations.\r\n \r\n | Optional Value | Purpose |\r\n |-----|-----| \r\n | `ApplicantIncome` | Applicant-specific income values including self-employed income inputs and addbacks.|\r\n | `ApplicantDebt` | Applicant-specific liabilities including home loans and ownership percentage |\r\n | `ApplicationExpenses` | Household-specific expenses include non-discretionary expenses and HEM values |\r\n \r\n Please note: \r\n * If your applicant is self employed you will need to set the `IsSelfEmployed` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n * If your applicant has a HECS debt you will need to set the `HasHecsDebt` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n " + "description": " This endpoint allows you to get serviceability metrics for your applications. By passing the `ApplicationReferenceNumber` for an existing application you can use the validated financials from earlier [`/application/create`](#Application/Create) and [`/application/manage`](#Application/Manage) requests to get accurate serviceability outputs.\r\n \r\n In each request you can provide a list of new facilities, for which serviceability metrics will be returned. \r\n \r\n You will be required to supply the following required information:\r\n * `ApplicationReferenceNumber`: this will extract validated financials from the application object from earlier processes.\r\n * `NewFacilities`: specifics of the new debt facilities.\r\n * `ConfigurationSet`: the lending policy configuration for which you wish to calculate serviceability metrics. This will be the lender or product enumeration you have configured within Xapii\r\n\r\n If you require HEM calculations you can set the `IsHemRequired` optional parameter. This is set to `false` by default. If you set this value to `true` then you must provide the following additional values under the `ApplicationContacts` object:\r\n * `EmailAddress`\r\n * `Dependants`\r\n * `MartialStatus`\r\n * `ResidentialStatus`\r\n \r\n\r\n You also have the ability to provide additional applicant and application level values over and above the outputs from earlier financial validation processes. These are optional - we will use validated figures and configured defaults where these are not provided. The table below lists the high level optional objects for tailoring serviceability calculations.\r\n \r\n | Optional Value | Purpose |\r\n |-----|-----| \r\n | `ApplicantIncome` | Applicant-specific income values including self-employed income inputs and addbacks.|\r\n | `ApplicantDebt` | Applicant-specific liabilities including home loans and ownership percentage |\r\n | `ApplicationExpenses` | Household-specific expenses include non-discretionary expenses and HEM values |\r\n \r\n Please note: \r\n * If your applicant is self employed you will need to set the `IsSelfEmployed` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n * If your applicant has a HECS debt you will need to set the `HasHecsDebt` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n " }, "response": [] } @@ -2711,7 +2711,7 @@ } ] }, - "description": "Before you can call the XAI Validate endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the XAI Validate team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" + "description": "Before you can call the Xapii endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the Xapii team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" }, "response": [] }, @@ -2773,7 +2773,7 @@ "create" ] }, - "description": " This endpoint allows you to create an \"application\", which is the object that holds all elements and represents a point-in-time product application from your customer. XAI Validate assigns each application a unique `ApplicationReferenceNumber` (Arn). You can use this value for subsequent calls.\r\n \r\n \r\n When you create an application you determine the data sources and data validation type you need, namely:\r\n 1. \"Detect and Position\" or \"declare and verify\": do you want XAI Validate to identify your customers' financial position and provide you with the insights or do you want XAI Validate to automate financial validation decisioning for you? If you choose a \"declare and verify\" approach you need to provide your customers' \"declared\" financials to the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.\r\n 2. your customers: you can link one or more applicants to an application. XAI Validate will combine any jointly held accounts as part of the linking process.\r\n 3. your customer data source: XAI Validate supports multiple data sources. See the table below for more information.\r\n \r\n \r\n The table below lists the parameters you need to populate based on your data validation choice above:\r\n \r\n | Function | Description |\r\n |-----|-----| \r\n | `ApplicationContacts` | These are the applicants applying for your product. XAI Validate currently supports up to two applicants.|\r\n | `ExternalDataId`| This is the reference information for your existing data aggregator. XAI Validate currently supports multiple data sources - see the table below for information.|\r\n | `ExternalApplicationReferenceNumber`| This is an application reference from your own system to allow you to easily correlate the XAI Validate `ApplicationReferenceNumber` with your own records.|\r\n | `IsActualsOnly`| This parameter is only used by those clients that require a \"declare and verify\" approach to financial assessment. By setting this boolean to `false` these customers can then call the [`/application/manage`](#/application/manage) endpoint to add their applicants' \"declared\" or \"stated\" financials. This value will default to `true` meaning XAI Validate will return your applicants' \"actual\" financial position from the data. If don't pass a value for `IsActualsOnly`, then automated assessment will be triggered when you receive a successful response. If you're passing `\"IsActualsOnly\": false` then automated assessment will wait for you provide your applicants' \"declared\" financials via the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.|\r\n \r\n XAI Validate supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your XAI Validate client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your XAI Validate application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Basiq (coming soon!) | `BSQ` | As list of your Basiq customer identifiers. | You should have a one to one linking of applicant to Basiq customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " + "description": " This endpoint allows you to create an \"application\", which is the object that holds all elements and represents a point-in-time product application from your customer. Xapii assigns each application a unique `ApplicationReferenceNumber` (Arn). You can use this value for subsequent calls.\r\n \r\n \r\n When you create an application you determine the data sources and data validation type you need, namely:\r\n 1. \"Detect and Position\" or \"declare and verify\": do you want Xapii to identify your customers' financial position and provide you with the insights or do you want Xapii to automate financial validation decisioning for you? If you choose a \"declare and verify\" approach you need to provide your customers' \"declared\" financials to the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.\r\n 2. your customers: you can link one or more applicants to an application. Xapii will combine any jointly held accounts as part of the linking process.\r\n 3. your customer data source: Xapii supports multiple data sources. See the table below for more information.\r\n \r\n \r\n The table below lists the parameters you need to populate based on your data validation choice above:\r\n \r\n | Function | Description |\r\n |-----|-----| \r\n | `ApplicationContacts` | These are the applicants applying for your product. Xapii currently supports up to two applicants.|\r\n | `ExternalDataId`| This is the reference information for your existing data aggregator. Xapii currently supports multiple data sources - see the table below for information.|\r\n | `ExternalApplicationReferenceNumber`| This is an application reference from your own system to allow you to easily correlate the Xapii `ApplicationReferenceNumber` with your own records.|\r\n | `IsActualsOnly`| This parameter is only used by those clients that require a \"declare and verify\" approach to financial assessment. By setting this boolean to `false` these customers can then call the [`/application/manage`](#/application/manage) endpoint to add their applicants' \"declared\" or \"stated\" financials. This value will default to `true` meaning Xapii will return your applicants' \"actual\" financial position from the data. If don't pass a value for `IsActualsOnly`, then automated assessment will be triggered when you receive a successful response. If you're passing `\"IsActualsOnly\": false` then automated assessment will wait for you provide your applicants' \"declared\" financials via the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.|\r\n \r\n Xapii supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your Xapii client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your Xapii application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " }, "response": [] }, @@ -2940,7 +2940,7 @@ "getstatus" ] }, - "description": " Retrieve the status of your automated financial assessment process. Financial validation has a diverse range of activities from retrieving provider data, normalising accounts and transactions, through to automated assessment of financial position. A `GroupId` will be returned in the response for the following endpoints, which you can use to monitor progress:\r\n - [`/application/create`](#/application/create)\r\n - [`/application/manage`](#/application/manage)\r\n \r\n We will return an overall status of the financial validation tasks. The status codes are:\r\n - `READY` - task processing has not yet started \r\n - `PROCESSING` - task processing is underway\r\n - `COMPLETED` - task processing has completed successfully\r\n - `FAILED` - a task has failed processing. XAI Validate will retry the task, so continue to monitor.\r\n - `DEAD` - oops... something's gone wrong. No further processing takes place - we'll monitor the system for these issues.\r\n " + "description": " Retrieve the status of your automated financial assessment process. Financial validation has a diverse range of activities from retrieving provider data, normalising accounts and transactions, through to automated assessment of financial position. A `GroupId` will be returned in the response for the following endpoints, which you can use to monitor progress:\r\n - [`/application/create`](#/application/create)\r\n - [`/application/manage`](#/application/manage)\r\n \r\n We will return an overall status of the financial validation tasks. The status codes are:\r\n - `READY` - task processing has not yet started \r\n - `PROCESSING` - task processing is underway\r\n - `COMPLETED` - task processing has completed successfully\r\n - `FAILED` - a task has failed processing. Xapii will retry the task, so continue to monitor.\r\n - `DEAD` - oops... something's gone wrong. No further processing takes place - we'll monitor the system for these issues.\r\n " }, "response": [] }, @@ -2986,7 +2986,7 @@ "getsummary" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] }, @@ -3032,7 +3032,7 @@ "getexpensesummary" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] }, @@ -3077,7 +3077,7 @@ "getserviceability" ] }, - "description": " This endpoint allows you to get serviceability metrics for your applications. By passing the `ApplicationReferenceNumber` for an existing application you can use the validated financials from earlier [`/application/create`](#Application/Create) and [`/application/manage`](#Application/Manage) requests to get accurate serviceability outputs.\r\n \r\n In each request you can provide a list of new facilities, for which serviceability metrics will be returned. \r\n \r\n You will be required to supply the following required information:\r\n * `ApplicationReferenceNumber`: this will extract validated financials from the application object from earlier processes.\r\n * `NewFacilities`: specifics of the new debt facilities.\r\n * `ConfigurationSet`: the lending policy configuration for which you wish to calculate serviceability metrics. This will be the lender or product enumeration you have configured within XAI Validate\r\n\r\n If you require HEM calculations you can set the `IsHemRequired` optional parameter. This is set to `false` by default. If you set this value to `true` then you must provide the following additional values under the `ApplicationContacts` object:\r\n * `EmailAddress`\r\n * `Dependants`\r\n * `MartialStatus`\r\n * `ResidentialStatus`\r\n \r\n\r\n You also have the ability to provide additional applicant and application level values over and above the outputs from earlier financial validation processes. These are optional - we will use validated figures and configured defaults where these are not provided. The table below lists the high level optional objects for tailoring serviceability calculations.\r\n \r\n | Optional Value | Purpose |\r\n |-----|-----| \r\n | `ApplicantIncome` | Applicant-specific income values including self-employed income inputs and addbacks.|\r\n | `ApplicantDebt` | Applicant-specific liabilities including home loans and ownership percentage |\r\n | `ApplicationExpenses` | Household-specific expenses include non-discretionary expenses and HEM values |\r\n \r\n Please note: \r\n * If your applicant is self employed you will need to set the `IsSelfEmployed` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n * If your applicant has a HECS debt you will need to set the `HasHecsDebt` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n " + "description": " This endpoint allows you to get serviceability metrics for your applications. By passing the `ApplicationReferenceNumber` for an existing application you can use the validated financials from earlier [`/application/create`](#Application/Create) and [`/application/manage`](#Application/Manage) requests to get accurate serviceability outputs.\r\n \r\n In each request you can provide a list of new facilities, for which serviceability metrics will be returned. \r\n \r\n You will be required to supply the following required information:\r\n * `ApplicationReferenceNumber`: this will extract validated financials from the application object from earlier processes.\r\n * `NewFacilities`: specifics of the new debt facilities.\r\n * `ConfigurationSet`: the lending policy configuration for which you wish to calculate serviceability metrics. This will be the lender or product enumeration you have configured within Xapii\r\n\r\n If you require HEM calculations you can set the `IsHemRequired` optional parameter. This is set to `false` by default. If you set this value to `true` then you must provide the following additional values under the `ApplicationContacts` object:\r\n * `EmailAddress`\r\n * `Dependants`\r\n * `MartialStatus`\r\n * `ResidentialStatus`\r\n \r\n\r\n You also have the ability to provide additional applicant and application level values over and above the outputs from earlier financial validation processes. These are optional - we will use validated figures and configured defaults where these are not provided. The table below lists the high level optional objects for tailoring serviceability calculations.\r\n \r\n | Optional Value | Purpose |\r\n |-----|-----| \r\n | `ApplicantIncome` | Applicant-specific income values including self-employed income inputs and addbacks.|\r\n | `ApplicantDebt` | Applicant-specific liabilities including home loans and ownership percentage |\r\n | `ApplicationExpenses` | Household-specific expenses include non-discretionary expenses and HEM values |\r\n \r\n Please note: \r\n * If your applicant is self employed you will need to set the `IsSelfEmployed` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n * If your applicant has a HECS debt you will need to set the `HasHecsDebt` parameter within the `ApplicationContact` to `true`. This value is `false` by default.\r\n " }, "response": [] } @@ -3156,7 +3156,7 @@ } ] }, - "description": "Before you can call the XAI Validate endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the XAI Validate team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" + "description": "Before you can call the Xapii endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the Xapii team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" }, "response": [] }, @@ -3217,7 +3217,7 @@ "create" ] }, - "description": " This endpoint allows you to create an \"application\", which is the object that holds all elements and represents a point-in-time product application from your customer. XAI Validate assigns each application a unique `ApplicationReferenceNumber` (Arn). You can use this value for subsequent calls.\r\n \r\n \r\n When you create an application you determine the data sources and data validation type you need, namely:\r\n 1. \"Detect and Position\" or \"declare and verify\": do you want XAI Validate to identify your customers' financial position and provide you with the insights or do you want XAI Validate to automate financial validation decisioning for you? If you choose a \"declare and verify\" approach you need to provide your customers' \"declared\" financials to the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.\r\n 2. your customers: you can link one or more applicants to an application. XAI Validate will combine any jointly held accounts as part of the linking process.\r\n 3. your customer data source: XAI Validate supports multiple data sources. See the table below for more information.\r\n \r\n \r\n The table below lists the parameters you need to populate based on your data validation choice above:\r\n \r\n | Function | Description |\r\n |-----|-----| \r\n | `ApplicationContacts` | These are the applicants applying for your product. XAI Validate currently supports up to two applicants.|\r\n | `ExternalDataId`| This is the reference information for your existing data aggregator. XAI Validate currently supports multiple data sources - see the table below for information.|\r\n | `ExternalApplicationReferenceNumber`| This is an application reference from your own system to allow you to easily correlate the XAI Validate `ApplicationReferenceNumber` with your own records.|\r\n | `IsActualsOnly`| This parameter is only used by those clients that require a \"declare and verify\" approach to financial assessment. By setting this boolean to `false` these customers can then call the [`/application/manage`](#/application/manage) endpoint to add their applicants' \"declared\" or \"stated\" financials. This value will default to `true` meaning XAI Validate will return your applicants' \"actual\" financial position from the data. If don't pass a value for `IsActualsOnly`, then automated assessment will be triggered when you receive a successful response. If you're passing `\"IsActualsOnly\": false` then automated assessment will wait for you provide your applicants' \"declared\" financials via the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.|\r\n \r\n XAI Validate supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your XAI Validate client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your XAI Validate application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Basiq (coming soon!) | `BSQ` | As list of your Basiq customer identifiers. | You should have a one to one linking of applicant to Basiq customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " + "description": " This endpoint allows you to create an \"application\", which is the object that holds all elements and represents a point-in-time product application from your customer. Xapii assigns each application a unique `ApplicationReferenceNumber` (Arn). You can use this value for subsequent calls.\r\n \r\n \r\n When you create an application you determine the data sources and data validation type you need, namely:\r\n 1. \"Detect and Position\" or \"declare and verify\": do you want Xapii to identify your customers' financial position and provide you with the insights or do you want Xapii to automate financial validation decisioning for you? If you choose a \"declare and verify\" approach you need to provide your customers' \"declared\" financials to the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.\r\n 2. your customers: you can link one or more applicants to an application. Xapii will combine any jointly held accounts as part of the linking process.\r\n 3. your customer data source: Xapii supports multiple data sources. See the table below for more information.\r\n \r\n \r\n The table below lists the parameters you need to populate based on your data validation choice above:\r\n \r\n | Function | Description |\r\n |-----|-----| \r\n | `ApplicationContacts` | These are the applicants applying for your product. Xapii currently supports up to two applicants.|\r\n | `ExternalDataId`| This is the reference information for your existing data aggregator. Xapii currently supports multiple data sources - see the table below for information.|\r\n | `ExternalApplicationReferenceNumber`| This is an application reference from your own system to allow you to easily correlate the Xapii `ApplicationReferenceNumber` with your own records.|\r\n | `IsActualsOnly`| This parameter is only used by those clients that require a \"declare and verify\" approach to financial assessment. By setting this boolean to `false` these customers can then call the [`/application/manage`](#/application/manage) endpoint to add their applicants' \"declared\" or \"stated\" financials. This value will default to `true` meaning Xapii will return your applicants' \"actual\" financial position from the data. If don't pass a value for `IsActualsOnly`, then automated assessment will be triggered when you receive a successful response. If you're passing `\"IsActualsOnly\": false` then automated assessment will wait for you provide your applicants' \"declared\" financials via the [`/application/manage`](#/application/manageApplicationFinancials) endpoint.|\r\n \r\n Xapii supports multiple data sources. The table below describes the supported data sources and the request specifics. Depending on your Xapii client setup you will be able to use two data sources by default - your chosen data aggregator and the connect your own data options:\r\n \r\n \r\n | Data Source | `DataProviderName` | `DataProviderReference` | Details |\r\n |-----|-----|-----|-----|\r\n | illion ODS BrokerFlow | `ODS` | A list of your BrokerFlow `DocumentIds`| You can provide multiple `DocumentIds` for each applicant. |\r\n | illion ODS MultiBank (coming soon!)| `ODSSCV` | None | When your customers link their accounts, their data will automatically synch with your Xapii application. |\r\n | Yodlee v1.1 | `YOD11` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Yodlee v1.0 | `YOD` | As list of your Yodlee customer identifiers. | You should have a one to one linking of applicant to Yodlee customer identifier. |\r\n | Connect your own data | `EXT` | None | By selecting `EXT` you will be required to upload your data to the application. Please see [`/financialvalidation/provideaccounts`](#/financialvalidation/provideaccounts) for more information. | \r\n " }, "response": [] }, @@ -3355,7 +3355,7 @@ "upload" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] }, @@ -3631,7 +3631,7 @@ } ] }, - "description": "Before you can call the XAI Validate endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the XAI Validate team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" + "description": "Before you can call the Xapii endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the Xapii team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" }, "response": [] }, @@ -3751,7 +3751,7 @@ } ] }, - "description": "Before you can call the XAI Validate endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the XAI Validate team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" + "description": "Before you can call the Xapii endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the Xapii team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" }, "response": [] }, @@ -3856,7 +3856,7 @@ "get" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] } @@ -3930,7 +3930,7 @@ } ] }, - "description": "Before you can call the XAI Validate endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the XAI Validate team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" + "description": "Before you can call the Xapii endpoints, you need to authenticate via the /token API. Successful authentication will return a token that can then be used to authorise your access to functional APIs. You'll need to include this token in the Authorization header in your calls.\r\n\r\nThe /token API URL includes values in the query path. The URL will look like this:\r\nhttps://{host}/oauth2/token?grant_type=client_credentials\r\n\r\nThe host value will either be auth.tictoc.ai for production or auth.stage.tictoc.ai for testing. You'll also need to include information in your headers:\r\n\r\n Authorization: Base64 encoded client_id and client_secret provided to you by the Xapii team as part of onboarding. The format is: \"Basic {client_id}:{client_secret}\"\r\n Content-Type: the value is \"application/x-www-form-urlencoded\"\r\n" }, "response": [] }, @@ -4035,7 +4035,7 @@ "get" ] }, - "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by XAI Validate and any \"reviewed\" financials from your users' interaction with the XAI Validate user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the XAI Validate assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the XAI Validate assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." + "description": "This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events.\r\n\r\nThe table below summarises the key objects returned:\r\nObject\tDescription\r\nAssessmentSummary\tThis list of objects is tailored to those clients undertaking \"declare and verify\" financial assessment. Each object in the list will align to a client-specific credit policy setting, including an automated decision outcome, the applicant's \"declared\" financials, the \"actual\" financials found by Xapii and any \"reviewed\" financials from your users' interaction with the Xapii user interface.\r\nApplicationResults\tThis object includes the results for application-specific automated assessments, specifically your applicants' total asset position (i.e. deposit).\r\nHouseholdResults\tThis object includes key descriptive statistics from the Xapii assessment of household-specific expenses including non-discretionary, discretionary and any removed expenses.\r\nApplicationContactResults\tThis object contains detailed information about the Xapii assessment of your applicants' financial position. Individual objects will be returned for income (salary, rental and other), home loans, credit cards and personal loans." }, "response": [] } diff --git a/XaiValidatePublicApiDefinition.yml b/XaiValidatePublicApiDefinition.yml index 10276c7..77648b8 100644 --- a/XaiValidatePublicApiDefinition.yml +++ b/XaiValidatePublicApiDefinition.yml @@ -691,7 +691,7 @@ paths: position. description: >- - This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the XAI Validare UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events. + This endpoint includes the automated assessment of financial position results. It reflects the automated assessment, and any of your users' interaction with the data in the Xapii UI. Using this endpoint you'll be able to retrieve a comprehensive assessment of your applicants' income, expenses, assets, liabilities and any behavioural flags such as high risk transactions or arrears events. The table below summarises the key objects returned: @@ -1179,7 +1179,7 @@ paths: The `FileType` is the MIME type of the document with enumerations: - |`FileType` | Description| + |`File Type` | Description| |-----|-----| |`application/msword` | Microsoft Word document | |`application/vnd.openxmlformats-officedocument.wordprocessingml.document` | Microsoft Word (docx) document | @@ -1195,7 +1195,7 @@ paths: The `DocumentType` is used to index and specify the type of document being uploaded: - | `DocumentType` | Description | + | `Document Type` | Description | |-----|-----| | `BS` | Bank Statement | | `CC` | Credit Card Statement| @@ -1303,12 +1303,17 @@ paths: post: tags: - Document - summary: Get a list of documents linked to an application. + summary: Get a list of documents description: >- - Get a list of documents filtered by document name or type and sort by various attributes in “Ascending” or “Descending” order. Once you have the document identifier, use [`/document/download`](#/document/download) to download that document. - + Retrieve a list of documents filtered by document name or type and sort by various attributes in “Ascending” or “Descending” order. Once you have the document identifier, use [`/document/download`](#/document/download) to download that document. + + ### Retrieving documents for specific applicants + + A few ways exist to receive a subset of the documents on an application. First, there is a raw `TextFilter`, which returns matching document names or document types. To get a list of documents based on document ownership, use `SearchCriteria` along with the applicant's `ContactIds`. - Supported sort fields: + A document can be related to a single applicant or both applicants. Use `IsExclusive` to denote whether to return documents that match **all** `ContactIds` (`true`) or **any** `ContactIds` (`false`). By default, we will respond with documents related to any applicant. + + ### Supported sort fields: | Fields (as strings) | Description | |-----|-----| @@ -1320,9 +1325,9 @@ paths: | `"Size"` | The size of the document. | | `"Uploaded By"` | The username of the person who uploaded the document. | - Supported Document types + ### Supported Document types: - | `DocumentType` | Description | + | `Document Type` | Description | |-----|-----| | `BS` | Bank Statement | | `CC` | Credit Card Statement| @@ -1348,27 +1353,51 @@ paths: | `COS` | Contract of Sale | | `OTHER` | Other document | - OCR Status: - + ### Digitised Documents - If you have OCR-powered Document Digitisation enabled on your account, the `OcrStatus` will describe the state of the digitisation processing. *Document digitisation is in closed beta, with a public release expected in 2024*. + Xapii offers two approaches to Document Digitisation: Statement OCR and Auto-redaction of tax file numbers. To get access to this feature, please get in touch with your Tiimely account manager. + + ### Statement OCR Responses - | `OcrStatus` | Description | + Digitise Bank Statements using Optical Character Recognition for use in automated decisioning. *Statement OCR is in closed beta, with a public release expected mid 2024*. + + | `Ocr Status` | Description | |-----|-----| | `CHECKING` | Determining if the document can be digitised. | - | `READY` | Preparing to digitise the document. | - | `PROCESSING` | Digitising the document. | - | `SUCCESS` | Successfully digitised the document. | - | `FAILED` | Digitisation failed, re-attempting. | - | `FAILED_ERROR` | Unable to digitise the document, usually due to poor document quality. | + | `READY` | Preparing to process the document. | + | `PROCESSING` | Processing the document. | + | `SUCCESS` | Successfully processed the document. | + | `FAILED` | Processing failed, re-attempting. | + | `FAILED_ERROR` | The document cannot be processed, usually due to poor quality. | | `FAILED_VALIDATION_RUNNING_BALANCE` | Unable to digitise the document due to an inconsistent running balance. | | `FAILED_VALIDATION_TRANSACTION_BALANCE` | Unable to digitise the document due to unexpected characters where a transaction should be. | | `FAILED_VALIDATION_TRANSACTION_DATE` | Unable to digitise the document due to a transaction having the incorrect date format. | | `FAILED_VALIDATION_TRANSACTION_AMOUNT` | Unable to digitise the document due to an unexpected transaction amount. | - | `DEAD` | Digitisation failed numerous times and will not be re-attempted. | - | `UNSUPPORTED` | We have yet to support digitisation on this type of document. | - | `UNIDENTIFIED` | We could not identify this document and could not digitise it. | - | `BLOCKED` | The system has blocked digitisation on this document to protect the integrity of the application. Blocking occurs after at least one digitisation step. | + | `DEAD` | Processing failed numerous times and will not be re-attempted. | + | `UNSUPPORTED` | We have yet to support this type of document or an issue has been reported via the user interface. | + | `UNIDENTIFIED` | We could not identify this document and could not process it. | + | `BLOCKED` | The system has blocked digitisation on this document to protect the integrity of the application. | + + ### Auto-redaction Responses + + Automatically redact tax file numbers from Tax Returns and Notices of Assessment using Optical Character Recognition. *Auto-redaction is in closed beta, with a public release expected mid 2024*. + + | `Ocr Status` | Description | + |-----|-----| + | `CHECKING` | Determining if the document can be redacted. | + | `READY` | Preparing to processs the document. | + | `PROCESSING` | Processing the document. | + | `SUCCESS` | Successfully processed the document. | + | `FAILED_VALIDATION` | Processing failed, re-attempting. | + | `REDACTION_FAILURE_MISS` | This file had more than five pages, so we recommend double-checking the document. | + | `REDACTION_SUCCESS_MOREFOUND` | Based on page count, this document had more Tax File Numbers than we expected. We recommend double-checking the document. | + | `REDACTION_FAILED_RUNTIME` | We couldn't find any Tax File Numbers. We recommend double-checking the document. | + | `REDACTION_SUCCESS_PARTIAL` | We attempted to redact the document, but something went wrong during processing. | + | `REDACTION_SUCCESS_NONSTANDARD` | This file was a mix of tax returns and income statements. We recommend double-checking the document. | + | `REDACTION_SUCCESS_UNUSUAL` | There were fewer Tax File Numbers than we expected. We recommend double-checking the document. | + | `MANUALLY_REDACTED` | This document has manual redactions made by the user. | + | `DEAD` | Processing failed numerous times and will not be re-attempted. | + | `UNSUPPORTED` | We have yet to support this type of document or an issue has been reported via the user interface. | operationId: getDocumentList parameters: - in: header @@ -1407,13 +1436,13 @@ paths: post: tags: - Document - summary: Get information about a document linked to an application. + summary: Get a single document description: >- - This endpoint allows you to retrieve a document information by its identifier. This identifier can be retrieved from the [`/document/getlist`](#/document/getlist) endpoint. + Retrieve a document by its `DocumentId` and `ApplicationReferenceNumber`. The document identifier can be retrieved from the [`/document/getlist`](#/document/getlist) endpoint. Once you have the document identifier, use [`/document/download`](#/document/download) to download that document. - The `DocumentType` in the response is defined as per the table below: + Supported document types: - | `DocumentType` | Description | + | `Document Type` | Description | |-----|-----| | `BS` | Bank Statement | | `CC` | Credit Card Statement| @@ -1438,6 +1467,52 @@ paths: | `BRD` | Borrower Repayment Declaration | | `COS` | Contract of Sale | | `OTHER` | Other document | + + ### Digitised Documents + + Xapii offers two approaches to Document Digitisation: Statement OCR and Auto-redaction of tax file numbers. To get access to this feature, please get in touch with your Tiimely account manager. + + ### Statement OCR Responses + + Digitise Bank Statements using Optical Character Recognition for use in automated decisioning. *Statement OCR is in closed beta, with a public release expected mid 2024*. + + | `Ocr Status` | Description | + |-----|-----| + | `CHECKING` | Determining if the document can be digitised. | + | `READY` | Preparing to process the document. | + | `PROCESSING` | Processing the document. | + | `SUCCESS` | Successfully processed the document. | + | `FAILED` | Processing failed, re-attempting. | + | `FAILED_ERROR` | The document cannot be processed, usually due to poor quality. | + | `FAILED_VALIDATION_RUNNING_BALANCE` | Unable to digitise the document due to an inconsistent running balance. | + | `FAILED_VALIDATION_TRANSACTION_BALANCE` | Unable to digitise the document due to unexpected characters where a transaction should be. | + | `FAILED_VALIDATION_TRANSACTION_DATE` | Unable to digitise the document due to a transaction having the incorrect date format. | + | `FAILED_VALIDATION_TRANSACTION_AMOUNT` | Unable to digitise the document due to an unexpected transaction amount. | + | `DEAD` | Processing failed numerous times and will not be re-attempted. | + | `UNSUPPORTED` | We have yet to support this type of document or an issue has been reported via the user interface. | + | `UNIDENTIFIED` | We could not identify this document and could not process it. | + | `BLOCKED` | The system has blocked digitisation on this document to protect the integrity of the application. | + + ### Auto-redaction Responses + + Automatically redact tax file numbers from Tax Returns and Notices of Assessment using Optical Character Recognition. *Auto-redaction is in closed beta, with a public release expected mid 2024*. + + | `Ocr Status` | Description | + |-----|-----| + | `CHECKING` | Determining if the document can be redacted. | + | `READY` | Preparing to processs the document. | + | `PROCESSING` | Processing the document. | + | `SUCCESS` | Successfully processed the document. | + | `FAILED_VALIDATION` | Processing failed, re-attempting. | + | `REDACTION_FAILURE_MISS` | This file had more than five pages, so we recommend double-checking the document. | + | `REDACTION_SUCCESS_MOREFOUND` | Based on page count, this document had more Tax File Numbers than we expected. We recommend double-checking the document. | + | `REDACTION_FAILED_RUNTIME` | We couldn't find any Tax File Numbers. We recommend double-checking the document. | + | `REDACTION_SUCCESS_PARTIAL` | We attempted to redact the document, but something went wrong during processing. | + | `REDACTION_SUCCESS_NONSTANDARD` | This file was a mix of tax returns and income statements. We recommend double-checking the document. | + | `REDACTION_SUCCESS_UNUSUAL` | There were fewer Tax File Numbers than we expected. We recommend double-checking the document. | + | `MANUALLY_REDACTED` | This document has manual redactions made by the user. | + | `DEAD` | Processing failed numerous times and will not be re-attempted. | + | `UNSUPPORTED` | We have yet to support this type of document or an issue has been reported via the user interface. | operationId: getDocument parameters: - in: header @@ -3210,10 +3285,15 @@ components: format: double example: 500.1112 TotalExistingMonthlyBufferedRepayment: - description: The sum of all debt repayments for facilities currently owned by all applicants. + description: The sum of all buffered debt repayments for facilities currently owned by all applicants. type: number format: double example: 3090.1134 + TotalExistingMonthlyUnbufferedRepayment: + description: The sum of all unbuffered debt repayments for facilities currently owned by all applicants. + type: number + format: double + example: 4000.1134 TotalNewMonthlyBufferedRepayment: description: The sum of all debt repayments for the new facility. type: number @@ -4750,6 +4830,7 @@ components: properties: ApplicationDocument: $ref: '#/components/schemas/DocumentSchema' + description: A list of documents. RequestId: type: string example: RojLCjD-ywPPMNg= @@ -4759,31 +4840,30 @@ components: - ApplicationReferenceNumber type: object properties: - ApplicationId: - type: string - description: Unique identifier for the application exclusive to our white-labelled mortgage solution, also known as an AUN. - example: "c080327e-79e1-43b0-b7ce-1a5fddee40d1" ApplicationReferenceNumber: type: string description: Unique identifier for the application. example: "ABC123456" + ApplicationId: + type: string + description: Unique identifier for the application exclusive to our white-labelled mortgage solution, also known as an AUN. + example: "c080327e-79e1-43b0-b7ce-1a5fddee40d1" SearchCriteria: type: object - description: Filter documents by specific criteria.. + description: Filter documents by specific criteria. properties: TextFilter: type: string description: Text filter for document name or type. ContactIds: type: array - description: Contact Ids of the document. + description: Contact ids related to the document. items: type: integer IsExclusive: type: boolean - description: Specifies the type of filtering that will be applied to the document's list. If true, returns the documents that have all the provided ContactIds. If false, returns the documents that have any of the ContactIds. + description: Indicates whether to return documents that match **all** `ContactIds` (`true`) or **any** `ContactIds` (`false`) - defaults to `false`. example: false - SortCriteria: type: object description: Sort documents by specific criteria. @@ -4922,7 +5002,7 @@ components: type: array items: type: string - example: ["ff80bff8-3bb2-4899-84cd-857499568f50", "851506c3-b321-4d27-8265-7d61d6429140"] + example: ["ff80bff8-3bb2-4899-84cd-857499568f50", "851506c3-b321-4d27-8265-7d61d6429140"] description: A list of unique customer ids. These are not the same as contact ids. DocumentStoreKey: type: string @@ -4941,7 +5021,7 @@ components: OcrStatus: type: string example: UNSUPPORTED - description: The processing status of a digitised document. + description: The processing status of a digitised document, used by both Statement OCR and Auto-redaction. enum: - CHECKING - READY @@ -4957,6 +5037,14 @@ components: - UNSUPPORTED - UNIDENTIFIED - BLOCKED + - FAILED_VALIDATION + - REDACTION_FAILURE_MISS + - REDACTION_SUCCESS_MOREFOUND + - REDACTION_FAILED_RUNTIME + - REDACTION_SUCCESS_PARTIAL + - REDACTION_SUCCESS_NONSTANDARD + - REDACTION_SUCCESS_UNUSUAL + - MANUALLY_REDACTED Id: type: integer description: The unique identifier of the document. @@ -4971,7 +5059,7 @@ components: type: string format: date-time description: The date the document was last updated. - LastUpdateBy: + LastUpdatedBy: type: string description: The user who last updated the document. RowVersion: