The Envizage quickstart guide is structured to provide short integration examples for common features of the Envizage APIs.
In order to use the API, a client must be registered at https://console.envizage.me
Service accounts are useful to register users for the registered client. The user must first request an access token via the OAuth handshake as described here.
Scenario modelling allows users to anticipate potential events that can be relevant to the household in the future.
Envizage allows the modelling of multiple scenarios each containing a different household configuration.
We recommend modelling the household as accurately as possible to start with and make changes to it, to analyse potential outcomes.
A household will already contain person, which is called “primary”. This person is the main actor in the household and the modelling is being done from this person’s point of view.
Household income is the combined incomes of all people sharing the household. It includes multiple forms of income like salaries and retirement income.
The incomes have to be assigned to the persons earning them or benefiting from them.
Create a Person's income. The income can be of one of the following types:
Create the Household Expenses. They can be of one of the following types:
Household financials may optionally include one of the following:
Goals are personal ambitions which they want to achieve in the future.
There are several types of goals supported to enable the modelling of commonly encountered aspirations.
Create one or more Goals of the following types as described here:
A simulation of the created scenario is submitted for execution as described here.
The scenario simulation results can be retrieved as described here
A household scenario can be modified (any of the above described scenario parameters may change) replaced as described here.
Alternatively the scenario can be cloned as described here.
The updated or cloned scenario can be re-executed as above.
The updated simulation results can be retrieved as described above.