Core Concepts

Company Roles

Privé's system is built around three distinct company types, each with specific responsibilities and API access:

1. Advisor Company

Role: Owns and manages client relationships and accounts

Responsibilities:

• Client onboarding and KYC
• Account management
• Portfolio construction and monitoring
• Generating client reports
• Order placement and execution

Key API Domains:

• Client Data Hub (create/update clients and accounts)
• Risk Profiling
• Investment Guidelines
• Reporting
• Ordering and Transactions

Use Case: A wealth advisory firm managing portfolios for 500 high-net-worth clients

2. Manager Company

Role: Creates and manages model portfolios and investment strategies

Responsibilities:

• Building model portfolios
• Creating virtual funds (vFunds)
• Defining asset allocation strategies
• Rebalancing model portfolios (which cascade to linked client accounts)

Key API Domains:

• Model Portfolio Management
• vFund Creation
• Rebalancing workflows

Use Case: An asset management firm offering three model portfolios (Conservative, Balanced, Aggressive) to multiple advisor companies

3. Execution Platform Company

Role: Maintains investment product universes and facilitates execution

Responsibilities:

• Managing product catalogs (mutual funds, ETFs, structured products, etc.)
• Providing product data (prices, fact sheets, performance)
• Handling order execution
• Transaction settlement

Key API Domains:

• Asset Hub (product universe and market data)
• Order execution and reconciliation

Use Case: A custodian bank offering 5,000 investment products to advisor firms

Multi-Tenancy Model

What is a Tenant?

In Privé, a tenant represents an isolated instance of company data. Each company (Advisor, Manager, or Execution Platform) operates within its own tenant.

Key Characteristics:

• Data Isolation: Tenants cannot access each other's data 🔒
• Separate Authentication: Each tenant has its own credential set 🪪
• Independent Configuration: Business rules, workflows, and integrations are tenant-specific ⚙️

API Tenant Parameter

Most API endpoints include a {tenant} path parameter:

/users/3/{tenant}/priveKey/{priveKey}
           ↑
      Tenant ID

Example:

# Advisor Company "WealthCo" (Tenant ID: wealthco-prod)
GET /users/3/wealthco-prod/priveKey/CLIENT-001

# Different Advisor Company "InvestFirm" (Tenant ID: investfirm-prod)
GET /users/3/investfirm-prod/priveKey/CLIENT-001

Client and Account Hierarchy

Data Model

Company (Advisor)
 └── Client (Investor/User)
      ├── Account 1 (e.g., Individual Brokerage)
      ├── Account 2 (e.g., Retirement Account)
      └── Account 3 (e.g., Joint Account)

Client (User)

• Represents an individual investor
• Contains personal information (name, contact, KYC details)
• Has a risk profile linked to their investment objectives
• Identified by priveKey or externalKey

API Endpoint: /users/3/{tenant}/priveKey/{priveKey}

Account (Investor Account)

• Represents a specific investment account owned by a client
• Contains holdings, transactions, and performance data
• May have investment guidelines that govern permissible investments
• Linked to a model portfolio or custom allocation

API Endpoint: /restful/investorAccounts/2/{tenant}/priveKey/{priveKey}

Key Identifiers

Using External Keys:

# Retrieve client by your CRM ID
GET /users/3/{tenant}/externalKey/CRM/CLIENT-12345

# Update account using your legacy system ID
PUT /investorAccounts/3/externalKey/LEGACY/ACCT-67890

Investment Guidelines

Purpose: Define permissible investments and constraints for accounts (e.g., "No tobacco stocks," "Max 10% in single security").

How It Works:

1. Create guideline with rules via API or Privé UI
2. Link guideline to account using PUT endpoint
3. Check compliance before/after trades using validation endpoint

API Endpoints:

• POST /investmentGuidelines/1/{tenant} — Create guideline
• PUT /restful/investorAccount/{accountKey}/investmentGuideline/{guidelineKey} — Link to account
• POST /investmentGuidelines/1/{tenant}/report — Validate portfolio against guidelines

Risk Profiles

Purpose: Capture client's risk tolerance and investment objectives to drive portfolio recommendations.

Types:

• MiFID II (European regulatory standard)
• Custom (your proprietary risk questionnaire)

Workflow:

1. Get risk definition for your questionnaire type
2. Create risk profile session with client responses
3. Submit completed session to calculate risk score
4. Link risk profile to client record

API Endpoints:

• GET /risk-profile/3/{tenant}/definition/type/{type} — Get questionnaire
• POST /risk-profile/3/{tenant}/session/type/{type} — Create session
• POST /risk-profile/3/{tenant}/result/type/{type} — Submit and score
• PUT /users/3/{tenant}/priveKey/{priveKey} — Link to client (update riskProfileRef)

Related Parties

Purpose: Model complex ownership structures (beneficiaries, trustees, authorized signers, etc.).

Use Cases:

• Trust accounts with multiple beneficiaries
• Corporate accounts with authorized traders
• Estate planning with power of attorney
• Family office structures

API Endpoints:

• POST /restful/relatedParties/1/{tenant} — Create related party
• GET /restful/relatedParties/1/{tenant}/{key} — Retrieve details
• PUT /restful/relatedParties/1/{tenant}/{key} — Update relationship

System Codes

Privé uses standardized codes for asset classification, geographic exposure, and document types. These codes ensure consistency across the platform.

Asset Classes

• EQUITY — Stocks and equity funds
• FIXEDINCOME — Bonds and fixed income
• ALTERNATIVE — Hedge funds, private equity
• REALESTATE — REITs and real estate funds
• CASH — Money market and cash equivalents

Regions

• NORTH_AMERICA — US, Canada
• EUROPE_DEVELOPED — Western Europe
• ASIA_EMERGING — China, India, Southeast Asia
• GLOBAL — Worldwide exposure

Document Types

• 2 — Fact Sheet
• 3 — KIID (Key Investor Information Document)
• 4 — Prospectus
• 10 — Product Key Facts

See System Reference for complete code lists