Get Started
Standard Objects
Get Started
Standard Objects
Overview of core entities in the CoreBanq system
This section provides an overview of the core entities in the system and their relationships.
Core Entities
Users
Users represent individuals who interact with CoreBanq. Key characteristics:
- Can be associated with multiple customers
- Have role-based access rights
- Link to personal data through personas
- Support multiple authentication methods
Credentials
Authentication methods associated with users:
| Type | Description | Usage |
|---|---|---|
| Primary email address | Required | |
| Phone | Mobile number | Optional |
| TOTP | Time-based One-Time Password | Optional |
| Telegram | Telegram account | Optional |
| WhatsApp number | Optional |
When a second credential is verified, 2FA is automatically activated for the user.
Customers
Represent organizations in the system:
- Private individuals
- Companies
- Organizations
- Financial institutions
Personas
Store personal information separately:
- Identity details
- Contact information
- Document records
- Enhanced privacy controls
Persona Links
Connect personas to other entities:
- User → Persona (personal data)
- Customer → Persona (stakeholder data)
- Shareholder → Persona (ownership data)
Entity Relationships
Common Fields
All entities share these standard fields:
| Field | Type | Description |
|---|---|---|
| id | UUID | Unique identifier |
| created_at | timestamp | Creation timestamp |
| created_by | UUID | Creator reference |
| modified_at | timestamp | Last update time |
| modified_by | UUID | Modifier reference |
| active | boolean | Status flag |
| metadata | jsonb | Custom attributes |
Security Features
- Role-based access control
- Data segregation
- Audit logging
- Field-level permissions
- Customer scoping
For detailed information on each entity’s attributes and methods, refer to their respective API documentation sections.