Entities

  • Each user is represented by a unique entity ID.
  • If you have two users, Jessica and Melissa, they will each have unique entity IDs.
    If not specified, default will be used as the entity ID.

You can use an entity object to manage connected accounts and perform actions on behalf of a user (more on this here). Here’s how to retrieve an entity object:

Connected Accounts

  • When a user connects their account, a connected_account object is created.
  • Connected Account securely stores authentication data such as API keys, access tokens and refresh tokens.

How to initiate a new connection for your user

Follow these steps to initiate a new connection for your user (for both OAuth and non-OAuth based Apps):

Initiate a new connection by passing the redirect url, entity id & app.

Each App integration has a unique integration ID. You can use this ID instead of the app name when creating connections.