Getting Started

What is Privé?

Privé is a comprehensive wealth technology platform that provides REST and GraphQL APIs for:

• Portfolio Management — Holdings, performance analytics, and rebalancing
• Client Onboarding & KYC — Risk profiling, compliance, and client data management
• Reporting — Consolidated statements, performance reports, and regulatory documents
• Transaction Management — Order execution, trade reconciliation, and cash operations

API Architecture

• Protocol: REST with JSON payloads (GraphQL available for complex queries)
• Authentication: JWT Bearer tokens
• Base URL (Production): https://api.privemanagers.com
• Base URL (UAT): https://api-uat.privemanagers.com
• Rate Limits: 1000 requests/hour per access token (varies by endpoint)

Prerequisites

Before you start integrating, ensure you have:

1. Company Setup — Your organization must be configured in the Privé system as one or more company types:

   • Advisor Company — Manages client accounts and portfolios
   • Manager Company — Creates model portfolios and virtual funds
   • Execution Platform Company — Maintains product universes

2. Credentials — You'll receive username/password pairs for each company role you need to access

3. Development Environment — We recommend starting in our UAT environment before moving to production

💡

Need setup assistance? Contact your Privé representative or email [email protected]

Your First API Call

Let's authenticate and retrieve a list of available API endpoints.

Step 1: Obtain an Access Token

curl -X POST https://api-uat.privemanagers.com/restful/login/ \
  -H "Content-Type: application/json" \
  -d '{
    "username": "your-username",
    "password": "your-password"
  }'

Response:

{
  "userDetails": {
    "username": "your-username",
    "userKey": "USER-12345",
    "groups": [
      0
    ]
  },
  "roles": [
    "ANONYMOUS"
  ],
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refreshToken": "string",
  "executionPlatformKey": "string",
  "tenant": "tenantNameString",
  "defaultCompanyInventorySource": "MARKET",
  "status": "SUCCESS",
  "companyKey": "COMPANY-67890"
}

Step 2: Make an Authenticated Request

curl -X GET https://api-uat.privemanagers.com/users/3/{tenant}/priveKey/{priveKey} \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Environments

⚠️ Important: Never use production credentials in UAT or vice versa.