Skip to main content

Quickstart Guide

The Envizage quickstart guide is structured to provide short integration examples for common features of the Envizage APIs.

Setup and Authenticate

Connect a Back-end application

Connect a Back-end application at and get Realm, Client ID and Client Secret values.

Obtain a Service Access Token

Service accounts are useful to register users for the connected application. As described here, the user must first request a service access token using Realm, client ID and client secret values.

Register a User

A user must be registered using the service access token that has been obtained from previous step, as well as realm, client ID and client secret values.

Obtain a User Access Token

In order to use the Envizage APIs, user must request a user access token. The request must include realm, client ID and client secret values and the 'grant_type' parameter must set to 'password'. If the request is successfull, the response will inculde the user access token.

Create a scenario

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.

Register Persons

A household will already contain a 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. Updating the primary person is described here and if applicable a partner as described here.

Register Incomes

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.

Register Person's Income

Create a Person's income. The income can be of one of the following types:

  • Earned Income
  • Employer Pension Contribution
  • Unearned Income

Register Household Expenses

Create the Household Expenses. They can be of one of the following types:

  • Living Expenses
  • Pension Contribution Expenses
  • Insurance Premium Expenses

Other Household Financials

Household financials may optionally include one of the following:

Set Goals

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:

  • Buy A House
  • Buy To Let
  • Buy A Car
  • Go To School
  • Have A Child
  • Travel
  • Eliminate Debt
  • Get Married
  • Sabbatical
  • Invest in a business
  • Move out
  • Relocate
  • Retirement
  • User Defined (custom)
  • Recurring User Defined

Execute a scenario

A simulation of the created scenario is submitted for execution as described here.

Check simulation results

The scenario simulation results can be retrieved as described here

Modify and Rerun a scenario

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.