Black Diamond

Black Diamond is a data sync + report delivery integration that imports households, accounts, and holdings, and can upload PDF reports.

Overview

Attribute	Value
Integration Type	Data Sync + Report Delivery
Authentication	OAuth 2.0 with OpenID Connect
Data Flow	Bidirectional (data in, reports out)
Owner	Qianwei Hao

Data Structure

Household
└── Accounts
    └── Holdings

API Services

Three separate endpoints:

• Core API v1 - Account and household data
• Relationship API v2 - Relationship queries
• Timeline API v1 - Report upload

Report Delivery

Uploads PDF to Timeline API, returns URL with audience and attachment parameters.

Authentication

OAuth 2.0 with OpenID Connect:

• Extracts sub from ID token for user reference
• Handles errors like “Firm is closed” and “User is locked”

Security Matching

• Primary: CUSIP
• Fallback: Asset ID
• Bidirectional enrichment supported

Code Locations

Component	Path
Connector	retail-api/app/Integrations/BlackDiamond/Connector.php
Integrator	retail-api/app/Integrations/BlackDiamond/Integrator.php
Models	retail-api/app/Integrations/BlackDiamond/Models/