What is Altafid?
Altafid is a wealth management and client relationship platform for financial advisory firms. It provides advisors with a unified view of their clients — who they are, who they are related to, what accounts they hold, and what interactions have taken place. Third-party integrations connect to Altafid through a REST API to create, read, and update this data programmatically.
Core concepts
The Altafid platform is organised around a small set of entities that represent the people, relationships, and activities in an advisory firm. Understanding how they connect is the key to building a successful integration.
Tenants
A tenant is your firm's isolated account on the Altafid platform. All data — contacts, households, notes, staff — belongs to exactly one tenant. When you authenticate, you receive a tenantUuid that must be included in every subsequent API call. No data crosses tenant boundaries.
| Field | Description |
|---|---|
tenantUuid | Unique identifier for your firm's workspace |
name | Full legal name of the firm |
code | Short human-readable identifier (e.g. CONPAT_UAT) |
Contacts
A contact is any person tracked in the platform — a client, a prospect, a beneficiary, or a related individual. Contacts are the primary record type for people your firm works with or wants to work with. They hold personal information, communication preferences, compliance data (KYC), and financial profile details.
Each contact belongs to a firm (your tenant, a partner firm, or an organisation) and can be linked to one or more households. A contact can also be invited to access a client portal, at which point credentials are created for them.
| Key field | Description |
|---|---|
contactUuid | Unique identifier |
firstName / paternalLastName | Full name |
contactType | ACTIVE client or SUBSCRIBER prospect |
stage | Where in the advisory pipeline this contact sits (tenant-defined) |
segment | Market segment classification (tenant-defined) |
preferredEmail | Primary contact email address |
Organisations
An organisation is a legal entity — a company, trust, fund, or other non-individual entity — that your firm tracks. Organisations can be employers of contacts, vehicles through which contacts invest, or clients in their own right. They can be linked to households and can have contact members (administrators, beneficial owners, etc.).
| Key field | Description |
|---|---|
organisationUuid | Unique identifier |
legalCompanyName | Official registered name |
industry | Sector classification (e.g. FINANCIAL_AND_INSURANCE_ACTIVITIES) |
identificationType / identificationId | Tax ID, company registration number, or EIN |
Organisations API documentation →
Households
A household is a named group that brings together contacts and/or organisations sharing a financial relationship. A household might represent a married couple, a family unit, an investment club, or a trust's beneficiaries. Households are the primary unit for consolidated reporting — portfolio values, AUM, and analytics roll up to the household level.
Each household has a designated relationship manager (a staff member) and can have multiple members, each with a defined role or relationship type (spouse, child, trustee, etc.).
| Key field | Description |
|---|---|
householdUuid | Unique identifier |
name | Display name (e.g. "Smith Family") |
relationshipManagerUuid | Assigned advisor staff UUID |
members | Contacts and/or organisations in this household |
Households API documentation →
Notes
A note is a rich-text record capturing an interaction, observation, or piece of analysis related to a contact. Notes serve as the activity log for the advisory relationship — meeting summaries, call logs, investment rationale, compliance annotations, and follow-up items. Notes support file attachments (uploaded via presigned S3 URLs) and can be associated with both a contact and a household.
| Key field | Description |
|---|---|
noteUuid | Unique identifier |
textContent | HTML-formatted note body |
associationType | Whether this note is linked to a contact, household, or both |
attachments | Files attached to this note (PDFs, images, documents) |
Staff
Staff are the users who access the Altafid platform on behalf of your firm. They can be advisors (who own client relationships), administrators (who manage the platform configuration), or managers (who oversee other advisors). When a staff member authenticates, their identity and role are embedded in the session token and control what data they can access.
Staff can be directly employed by the tenant (TENANT_STAFF) or assigned through a partner firm (PARTNER_STAFF).
Staff Management API documentation →
Saved Views
Saved views are personalised column and filter configurations that a staff member stores for their entity list screens (contacts, organisations, households, tasks). Each user can save up to five views per entity type and mark one as their favorite default. Views persist across sessions and devices.
Saved Views API documentation →
Entity relationships
The diagram below shows how the core platform entities are related to each other.
Key relationships to understand for integration:
- A contact can belong to zero or many households. A household can have zero or many contacts as members.
- A contact can be associated with zero or many organisations (as an employee, beneficial owner, or director).
- A household has one assigned staff member as relationship manager, but multiple staff can view and work with the household.
- All records — contacts, organisations, households, notes — are owned by the tenant and invisible to other tenants.
API structure
The Altafid API is versioned and organised by entity. Most entity endpoints are under /api/{entity}. Filtering and aggregation endpoints use the v2 path prefix (/api/v2/{entity}).
| Version | Pattern | Use |
|---|---|---|
| v1 (default) | /api/{entity} | Standard CRUD operations |
| v2 | /api/v2/{entity} | Advanced filtering and filter-value lookups |
| Public | /api/public/... | Unauthenticated endpoints (branding) |
Every authenticated request requires four headers in addition to the bearer token. See Shared Conventions — Required headers for details.