Identity

Represents a user or company identity with details like external ID, status, session data, or linked bank accounts.

Overview

The Identity serves as a central place to manage and track identities in the system. An identity can represent either an individual user or a company. Key attributes include the external ID, status (e.g., active, pending), and session information. The identity model is crucial for maintaining the integrity of the user or company’s presence in the system and includes links to bank accounts and other relevant entities.

Identity

Field	Type	Description
id	string	Unique identifier (UUID).
identityExternalId	string	External ID representing the identity in external systems.
type	string	Specifies the identity type (USER, COMPANY).
status	string	Current status (ACTIVE, PENDING, BLOCKED, etc.).
contract	string	Contract related to the identity.
image	string	URL to the identity's avatar or image.
session	Session	Information about the current session.
bankAccounts	array[bankAccount]	List of bank accounts linked to the identity.
user	user	User details (if the type is USER).
company	company	Company details (if the type is COMPANY).
extendedData	array[extendedData]	Additional custom key-value pairs for flexibility.
createdAt	string	Timestamp when the identity was created (ISO 8601).
updatedAt	string	Timestamp when the identity was last updated (ISO 8601).

Session

Field	Type	Description
deviceToken	string	A unique token identifying the device in session.
IP	string	The IP address of the device being used.
loginAttempts	integer	Number of failed login attempts in this session.