The aim of the Starter Workflows is to help developers with the setup and get connected to the API as soon as possible. Please take a look at the flows covering different business cases to get the most out of it.
The Basic Workflow is intended to demonstrate how the API works.
It covers the following:
- Obtain the Service Account Token - this grants access to the workspace.
- Creates a guest user and a minimal Household with one person living in it, who has an income and a monthly living expense.
- The only goal in the household is retirement. This is a mandatory goal for each household.
- Shows how to execute the scenario and how to get the simplest of results.
This workflow contains all the different types of goals that can be added to a household using the dedicated end-points for each goal type.
This workflow contains all the different types of goals that can be added to a household using the single generic end-point for each goal.
Sets up a scenario where two people live in the household and they wish to buy a house. The results will show the likelihood of that happening.
Contains a single person household who contributes to a private pension fund.
Sets up a household with two people living in it, who both posses life insurance and they are planning to have a child.