What Is the Dynamic Planner Open API?

The Dynamic Planner Open API provides secure, standards‑based programmatic access to the data and services within the Dynamic Planner platform. It enables fintech partners, advisers, and enterprise systems to retrieve, update, and exchange core planning data — including clients, profiling results, and financial arrangements.

The API follows modern REST principles, uses JSON throughout, and provides consistent patterns for authentication, pagination, error handling and diagnostic tracing.

• RESTful endpoints
• OAuth 2.0 authentication (Hybrid flow & Client Credentials)
• Consistent response envelopes with paging
• Structured error responses with trace identifiers
• ACID‑safe write operations with idempotency recommendations

Core Capabilities

The Open API provides access to a wide range of functional areas:

• 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).

Each capability adheres to the same service standards, making the API predictable and integrator‑friendly.

How Access Works

Access to the Open API is controlled through a combination of OAuth 2.0 authentication and Dynamic Planner’s organisational visibility model. Integrators receive:

• OAuth client credentials for machine‑to‑machine APIs
• Hybrid flow credentials for user‑centric flows where data visibility is tied to the authenticated employee
• Role and Organisation Unit filtering automatically applied based on the user or system context

Data is only returned when the calling user or integration has explicit permission to view it.

Developer Experience

To help you build robust, production‑ready integrations, the API includes:

• Clear pagination rules with pageSize and pageNumber
• Meaningful 4xx and 5xx error structures
• Diagnostic headers:
  • x-dt-traceid — caller‑provided correlation ID
  • x-dt-requestid — DP‑generated unique request key
• Guidance on retry strategies and resilience patterns
• Idempotency recommendations for safe updates

The API documentation follows a consistent layout and presents examples, best practices and related guides throughout.

Getting Started

If you are new to the Dynamic Planner Open API, the full step‑by‑step introduction to authentication, requesting access, and making your first API call is provided in the Getting Started guide.

You can also explore the full API definition through the API Reference section, which links directly to the Swagger/OpenAPI specifications.