API Documentation

Authentication Required

All API requests require an API key passed in the header. Enterprise clients receive their API key upon account setup. Contact your account manager for access.

Authorization: Bearer YOUR_API_KEY

Rate Limiting

API requests are limited to 100 requests per minute per API key. Enterprise clients can request higher limits.

Client Management

GET /api/v1/clients

Retrieve a list of all clients associated with your advisor account.

Response

{
  "success": true,
  "clients": [
    {
      "id": "client_abc123",
      "first_name": "John",
      "last_name": "Smith",
      "email": "john.smith@example.com",
      "created_at": "2024-01-15T10:30:00Z",
      "plan_count": 2
    }
  ],
  "total": 45
}
                

POST /api/v1/clients

Create a new client profile.

Request Body

Parameter	Type	Required	Description
first_name	string	Yes	Client's first name
last_name	string	Yes	Client's last name
email	string	Yes	Client's email address
date_of_birth	string	No	Date of birth (YYYY-MM-DD)
phone	string	No	Contact phone number

GET /api/v1/clients/{client_id}

Retrieve detailed information about a specific client.

Plan Management

GET /api/v1/clients/{client_id}/plans

Retrieve all retirement plans for a specific client.

POST /api/v1/clients/{client_id}/plans

Create a new retirement plan for a client.

Request Body

Parameter	Type	Required	Description
name	string	Yes	Plan name/description
household_type	string	No	single, couple, or family
initial_data	object	No	Initial plan data (income, pensions, etc.)

GET /api/v1/plans/{plan_id}

Retrieve full plan data including all financial details.

PUT /api/v1/plans/{plan_id}

Update an existing plan with new data.

Calculations

POST /api/v1/calculate/projection

Run retirement projection calculations on provided data.

Request Body

Parameter	Type	Required	Description
current_age	integer	Yes	Client's current age
retirement_age	integer	Yes	Target retirement age
pension_pots	array	Yes	Array of pension pot objects
include_state_pension	boolean	No	Include State Pension in projections
ni_years	integer	No	National Insurance qualifying years

POST /api/v1/calculate/tax

Calculate UK income tax based on provided income sources.

POST /api/v1/calculate/monte-carlo

Run Monte Carlo simulation with custom parameters.

Request Body

Parameter	Type	Required	Description
initial_value	number	Yes	Starting portfolio value
annual_contribution	number	Yes	Yearly contribution amount
years	integer	Yes	Projection period in years
simulations	integer	No	Number of simulations (default: 1000)
mean_return	number	No	Expected annual return % (default: 7)
std_dev	number	No	Standard deviation % (default: 15)

Reports

GET /api/v1/plans/{plan_id}/report

Generate and download a PDF report for a plan.

Query Parameters

Parameter	Type	Default	Description
format	string	pdf	Output format: pdf or html
include_monte_carlo	boolean	true	Include Monte Carlo section
include_tax	boolean	true	Include tax analysis

Client Management

Response

Request Body

Plan Management

Request Body

Calculations

Request Body

Request Body

Reports

Query Parameters

Ready for Enterprise Access?