Overview

Dynamic Planner’s Open API provides a modern, secure, and scalable way to integrate with financial planning workflows. Whether you're synchronising CRM data, retrieving valuations, analysing risk, or responding to client‑driven events, the API offers predictable patterns, consistent resource models, and a unified authentication approach.

This page summarises the core features across domains, operational capabilities, and runtime behaviours.

Core Domains

The Open API provides structured access to several functional domains:

• CRM & Client Data — Clients, relationships, personal data, lifecycle status, and organisation‑unit visibility filtering.
• Finances — Incomes, expenditures, investments, pensions, valuations, assets, liabilities and protection.
• Profiling — Questionnaires, results, factors, risk levels and losses & gains modelling.
• Tracking — Read‑only portfolio views across investments and pensions, including ownership, valuations and risk‑level context, ideal for portals, MI dashboards and consolidated reporting.
• Events & Notifications — Real‑time webhook-style callbacks for important lifecycle actions (e.g. client document created).

All domains follow shared patterns for authentication, pagination, filtering, diagnostics, and error handling.

CRM Features

The CRM domain enables integrations to manage and synchronise client information, including:

• Create, update, or retrieve Client records
• Manage Relationships and Self‑Relationships
• Access Organisation Units and visibility rules
• Retrieve and upload documents related to clients
• Synchronise employee and licensing information

CRM endpoints are typically used for onboarding workflows, CRM synchronisation, client document delivery, and creating personalised advice journeys.

Finances Features

The Finances API provides deep data for investment and pension arrangements, including:

• Holdings, transaction amounts, fund breakdowns
• Income, expenditures, contributions and withdrawals
• Assets, liabilities and protections
• Latest or historical valuations
• Ownership (joint or individual) and percentages
• Policy / contract references
• Investment characteristics and metadata

This data forms the foundation for suitability reports, portfolio analytics, financial planning services and integrations into valuation engines.

Profiling Features

Profiling captures client preferences, attitudes to risk, sustainability choices and investment suitability factors.

• Questionnaire structures
• Client responses
• Scoring and computed risk-level outputs (e.g. RL5)
• Profiling results linked to investment analysis
• Support for multiple risk frameworks (if enabled)

Profiling results are used across Tracking and suitability workflows and are available through the API for CRM synchronisation, portfolio management, and client review journeys.

Tracking Features

The Tracking API provides read‑only visibility of all investments and pensions associated with a client or set of clients. It consolidates holdings, valuations, ownership, and risk analysis into a consistent structure designed for reporting, dashboards, and MI.

• Retrieve consolidated investment and pension arrangements
• Access latest and historical valuations
• View ownership structures and percentages
• Analyse risk‑level output linked to Profiling
• Use for MI dashboards, review journeys, and data‑quality analysis

Tracking is ideal for portals and systems that require a unified view of a client’s financial arrangements without mutating data.

Event‑Driven Integrations

Dynamic Planner’s Events and Subscriptions model enables downstream systems to react to changes in near real‑time.

• Subscribe to topics such as document creation, client updates, results updates
• Configurable callback URLs
• Optional HMAC signing for verification (SHA‑1 / SHA‑256)
• Event history retrieval allows auditing and replay
• Idempotent event delivery logic recommended

Events use a predictable schema and support workflows such as CRM enrichment, automated notifications, or triggering downstream analytics.

Platform‑Wide Features

Across all domains, the API provides consistent patterns that simplify integration:

Authentication & Access Control

• OAuth 2.0 (Hybrid Flow + Client Credentials)
• Subscription key per environment
• Organisation Unit (OU) scoping
• Employee context and visibility rules

Diagnostics

• x-dt-requestid for request tracking
• x-dt-traceid supplied by the client for correlation
• Standard JSON error envelopes

Paging & Filtering

• Consistent parameters: pageSize, pageNumber
• Wide support for filters using comma‑separated lists
• Safe iteration patterns for bulk synchronisation

Consistency & Versioning

• Stable resource URLs per domain (e.g. /crm/v1, /finances/v1)
• Predictable schemas for IDs, paging envelopes, and content structures
• Clear backward‑compatible versioning strategy

Environments

• Development / Integration — For onboarding, testing and building new features.
• Production — Secure, change‑controlled environment for live client data.

Both environments share the same base URL (https://open-api.dynamicplanner.com); access depends on the subscription key and OAuth client assigned.