Account - Overview

An Account contains permissioned users that collabrate on a specific credits and incentives portfolio. An Account can either be:

• Single Account - one Account for one credits and incentive portfolio.
• Parent/Child Account - Parent Account users have global access of all Child Accounts, whereas users of a Child Account only have access to that specific Child Account. Use cases include: (1) an advisor creating/updating client accounts on Incentify where each client is an individual Child Account and (2) a corporate entity creating/updating subsidiary accounts on Incentify where each subsidiary is an individual Child Account.

Methods

The API supports the following methods for Account resources:

• POST - Create / Update
  • Insert or updates an Account by requiring (and matching on) an internal_account_id (ie; the ID of the object on your internal system).

Resource Representation

The following JSON structure shows the format of a Account resource:

{
    "id": integer,
    "internal_account_id": string,
    "title": string,
    "created_at": string (RFC 3339 Format - 2022-05-03T17:13:44Z),
    "updated_at": string (RFC 3339 Format - 2022-05-03T17:13:44Z)
}

Resource Properties

The following table defines the properties that appear in this resource:

Key	Type	Definition
id	integer	The ID of the Account.
internal_account_id	string	The ID of the account on your internal system.
title	string	The name of the Incentify account.
created_at	string	The date and time that the Account was created. The value is specified in RFC 3339 Format (2022-05-03T17:13:44Z).
updated_at	string	The date and time that the Account was last updated. The value is specified in RFC 3339 Format (2022-05-03T17:13:44Z).