The user object represents an end-user of your application. This object encapsulates all of the financial details of an individual (such as list of accounts and transactions) along with the relationships that they hold with each institution (i.e. connections).

Use this object to keep your list of users in sync with the Basiq server. Once a user ceases to use your application, it is strongly recommended that the user object is deleted.

Attributes

type

Value is "user".

id

A string that uniquely identifies the user.

email

The end-users email address.

mobile

The end-users mobile number.

firstName

The end-users first name.

lastName

The end-users last name.

{
  "type": "user",
  "id": "ea3a81",
  "email": "[email protected]",
  "mobile": "+61410888666",
  "firstName": "Joe",
  "lastName": "Bloggs",
  "links": {
    "self": "https://au-api.basiq.io/users/ea3a81"
  }
}