Skip to main content

Users

In most integrations, you manage end users on your side and want to access information about their financial situation. The first step is to create a corresponding User in the finoOS API. See Add User.

Depending on your use case, you can create different types of users:

  • Person User: Represents an individual person. This is the most common user type.
  • Company User: Represents a company or organization.

Choosing the correct user type is important, as it determines the available scopes, categorization, and associated data.

As described in previous sections, you must provide an accessToken in the Authorization header for all requests. Additionally, you can change the tenant context of a user. For more details, see Tenancy.


User Lifecycle

The typical lifecycle of a user in the finoOS API consists of the following steps:

  1. Create a user
  2. Connect the user’s financial data (read more about user connections in the Connections section)
  3. Analyze the user’s financial data
    • automatically after the data has been received, or
    • manually by calling the Analyze User endpoint
  4. Retrieve analytics results via:
    1. Webhooks, or
    2. Polling the relevant analytics endpoints
  5. Delete the user when no longer needed:
    1. Automatically by setting an expiresIn value when creating the user
    2. Manually using the Delete User endpoint

It is recommended not to delete users immediately after data retrieval, as you or your end users may want to update data or request support later. A common approach is to set an expiresIn value when creating the user (for example, one week).

Steps 2–4 represent the analysis lifecycle and can be repeated as often as required, for example if an end user connects multiple bank logins. Learn more about the analysis lifecycle in the Analysis Lifecycle section.