Create a client [DEPRECATED: Use create an account route]

POST /api/v1/client

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

application/json

Body Required

title string

Title
first_name string Required

First Name
middle_name string

Middle Name
last_name string Required

Last Name
maiden_name string

Maiden Name
email string

Email address
phone string

Clients primary phone number
assigned_adviser_uuid string

The UUID of the employee that the client directly reports to
assigned_administrator_uuid string

The UUID of the adviser employee that the client has been assigned
assigned_paraplanner_uuid string

The UUID of the paraplanner employee that the client has been assigned
introduced_by_uuid string

The UUID of the introducer for this client
send_welcome_email boolean

Set to true if you would like Plannr to send an email to the client on account creation
date_of_birth date

Date of birth
gender string

Gender. Possible values are: male, female, non-binary, transgender, intersex, other and unknown
ni_number string

National Insurance Number
nickname string

preferred nickname of the client
target_retirement_age integer

Target retirement age.
pronouns string

Pronouns
smoker_status string

Smoker Status. Possible values are: smoker, non-smoker, vaper, ex-smoker, never-smoked, unknown
residential_status string

Residential status
country_of_residence string

Country of residence
marital_status string

Marital Status. Possible values are: single, cohabiting, married, divorced, civil-partnership, dissolved-civil-partnership, widowed, separated, engaged, in-relationship, other, unknown
is_vulnerable string

whether the client is vulnerable. Possible values are: "yes", "no", and "possibly"
is_prospect boolean

Denotes if the client is a prospect or not.
prospect_converted_at date

The datetime when the prospect was converted into a client.
value integer

The value of the client in penny format. E.g £5,000 would be 500000.
is_uk_resident boolean

Whether the client is a UK resident or not.
is_uk_domicile boolean

Whether the client is a UK domicile or not.
expected_retirement_age integer

The expected retirement age.
state_retirement_age integer

The state retirement age.
nationalities array[string]

Nationalities of the client. You can use the api/v1/static/nationalities endpoint to get our list.
vulnerability_details string

Any details regarding the client's vulnerabilities.
third_party_offered boolean

Whether the client has been offered any third party.
procedure_adaptation boolean

Whether any procedures need to be adapted to the client.
adaption_details_notes boolean

Any notes regarding adaptations
client_preferences string

Any client preferences.
current_state_of_health string

The client's current state of health.
state_of_health_explanation string

Explanation of the current state of health.
cigarettes_daily integer

The amount of cigarettes the client smokes a day.
smoker_since date

The date of when the client started smoking.
long_term_care_needed boolean

Whether the client required long term care.
long_term_care_notes string

Notes on the client's long term care.
has_will boolean

Whether the client has a will or not.
will_notes string

Notes on the client's will.
will_last_reviewed date

The date of the last time the will's been reviewed.
has_power_of_attorney boolean

Whether the client has power of attorney.
power_of_attorney_notes string

Notes on the client's power of attorney.
first_contact_date date

The date of the first contact.
units_of_alcohol_weekly integer

The units of alcohol digested weekly.
height integer

The height of the client in centimeters.
weight integer

The weight of the client in pounds.
health_notes string

Notes on the client's health.
has_iht_planning boolean

Whether the client has Inheritance Tax (IHT) planning or not.
iht_planning_notes string

Notes on the client's Inheritance Tax (IHT) planning.
has_gifted_family boolean

Whether the client has gifted the family.
gift_notes string

Notes on the gifts.
is_anticipating_inheritance boolean

Whether the client is anticipating/ expecting any inheritance.
anticipating_inheritance_notes string

Notes on the client's inheritance anticipation/ expectations.
next_review_date date

Date of next review
previous_review_date date

Date of previous review
anniversary_review_date date

Anniversary review date
is_will_accurate boolean

Does your current will reflect your wishes?
will_executors string

Who are the executors?
will_location string

Where is the will stored?
will_bequests_detail string

Details of any Bequests
is_poa_registered_epa_or_lpa string

Is the Power of Attorney Registered as a EPA or LPA
are_poa_appointed_for_health_or_wealth string

Are the Attorneys appointed for Health, Wealth or Both?
poa_attorney_appointed_at date

When were the Attorney’s appointed?
will_poa_details string

Who are the Attorney’s?
are_poa_documents_registered boolean

Are the documents registered?
will_gifts_details string

Notes of gifts
groups array[string]

Group UUIDs to sync client to.
is_in_receipt_of_your_state_pension boolean

Are you in receipt of your State Pension
has_obtained_a_forecast boolean

Have you recently obtained a forecast
date_of_forecast date

What is the date of the obtained forecast
projected_state_pension integer

What is the projected State Pension
years_of_national_insurance_contributions integer

How many years have you made Nation Insurance Contributions
pension_notes string

Notes on the pension
status_uuid string

The status of the client.
date_of_marriage date

Date of marriage
is_deceased boolean

Denotes if the client is deceased
deceased_at date

Date of death
is_married_to_partner boolean

Denotes if the client is married to their partner
checked_sanctions_at date

Date the client was checked for sanctions
lead_source string

Marks the lead source of the client
write_to_whom string

Marks the name of the client to write to
passport_number string

The passport number of the client
do_not_contact_via_fax boolean

Denotes if the client can be contacted via fax
do_not_contact_via_mail boolean

Denotes if the client can be contacted via mail
do_not_contact_via_sms boolean

Denotes if the client can be contacted via SMS
do_not_contact_via_email boolean

Denotes if the client can be contacted via email
do_not_contact_via_telephone boolean

Denotes if the client can be contacted via telephone
do_not_visit boolean

Denotes if the client can be visited
do_not_market boolean

Denotes if the client can be marketed to
client_regulatory_classification string Required

The regulatory classification of the client. Possible values are: retail_client, professional_client, eligible_counterparty, not_applicable and unknown
external_reference array[string]

A third-party external reference to attach when creating the model. The third party must be one of the following: adviser_office, aj_bell, be_iq_organisation, cash_calc, conquest, filehaven, finio, fundment, intelliflo_office, nucleus, octopus_money, p1, parmenion, seccl, smartsearch, soderberg and transact_remuneration

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- type string
  
  Account type
- role string
  
  Account role
- first_name string
  
  First name
- last_name string
  
  Last name
- name string
  
  Name
- email string
  
  (Deprecated - Please use primary_email instead). The email of the account.
- photo_url string
  
  URL for initial avatar image
- firm object
  
  Firm
  
  Hide firm attributes Show firm attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  address_1 string
  
  address_2 string
  
  town_city string
  
  county string
  
  postcode string
  
  country string
  
  regulatory_text string
  
  logo string
  
  logo_icon string
  
  brand_colours object
  
  Hide brand_colours attributes Show brand_colours attributes object
  
  sidebar_background string
  
  sidebar_accent string
  
  sidebar_text string
  
  sidebar_hover string
  
  sidebar_active string
  
  sidebar_title_background string
  
  sidebar_title_primary string
  
  sidebar_title_secondary string
  
  sidebar_title_secondary_hover string
  
  email_background string
  
  email_logo_background_panel string
  
  email_sub_text string
  
  email_button_background string
  
  email_button_text string
  
  portal_sidebar_button_background string
  
  portal_sidebar_button_hover string
  
  portal_sidebar_button_active string
  
  portal_brand_title string
  
  portal_brand_sub_title string
  
  portal_sidebar_title string
  
  portal_sidebar_text string
  
  portal_sidebar_text_hover string
  
  portal_sidebar_text_active string
  
  portal_sidebar_icon string
  
  portal_sidebar_icon_hover string
  
  portal_sidebar_icon_active string
  
  portal_background string
  
  portal_sidebar_account_title string
  
  portal_sidebar_account_email string
  
  portal_sidebar_divider string
  
  portal_dashboard_bg_one string
  
  portal_dashboard_bg_two string
  
  portal_sidebar_collapse_button string
  
  portal_sidebar_collapse_button_hover string
  
  portal_sidebar_user_select_background string
  
  portal_sidebar_user_select_hover string
  
  portal_sidebar_user_select_text string
  
  portal_sidebar_user_select_text_hover string
  
  portal_sidebar_user_select_border string
  
  portal_sidebar_user_select_border_hover string
  
  is_subscribed boolean
  
  addon_subscriptions string
  
  keep_deleted_files_for integer
  
  tax number
  
  month_end integer
  
  statement_frequency string
  
  billing object
  
  Hide billing attributes Show billing attributes object
  
  invoice_address_1 string
  
  invoice_address_2 string
  
  invoice_town_city string
  
  invoice_county string
  
  invoice_postcode string
  
  invoice_country string
  
  invoice_email string
  
  task_board_template string
  
  ip_whitelist array[string]
  
  welcome_paragraph_html string
  
  email_welcome_paragraph_html string
  
  show_fact_find_illustrations boolean
  
  cc_email_addresses array[string]
  
  bcc_email_addresses array[string]
  
  reply_to_email_address string
- primary_phone_number object
  
  Primary phone number
  
  Hide primary_phone_number attributes Show primary_phone_number attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  name string
  
  value string
  
  phone_number_meta object
  
  Hide phone_number_meta attributes Show phone_number_meta attributes object
  
  country string
  
  formatted string
  
  accounts string
- primary_email object
  
  Primary email
  
  Hide primary_email attributes Show primary_email attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  name string
  
  value string
  
  phone_number_meta object
  
  Hide phone_number_meta attributes Show phone_number_meta attributes object
  
  country string
  
  formatted string
  
  accounts string
- current_time_entry object
  
  Current time entry
  
  Hide current_time_entry attributes Show current_time_entry attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  description string
  
  trackable_type string
  
  trackable string
  
  start_date string
  
  end_date string
  
  is_active boolean
  
  total_time_in_minutes integer
  
  computed_time_elapsed_in_seconds integer
  
  account string
- assigned_adviser object
  
  Assigned adviser
  
  Hide assigned_adviser attributes Show assigned_adviser attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string
- assigned_administrator object
  
  Assigned administrator
  
  Hide assigned_administrator attributes Show assigned_administrator attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string
- assigned_paraplanner object
  
  Assigned paraplanner
  
  Hide assigned_paraplanner attributes Show assigned_paraplanner attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string
- introduced_by object
  
  Introduced by
  
  Hide introduced_by attributes Show introduced_by attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string
- groups array[object]
  
  Groups
  
  Hide groups attributes Show groups attributes object
  
  uuid string
  
  name string
  
  slug string
  
  participants_count string
  
  participants object
  
  Hide participants attributes Show participants attributes object
  
  uuid object
  
  Hide uuid attributes Show uuid attributes object
  
  example string
  
  description string
  
  role object
  
  Hide role attributes Show role attributes object
  
  example string
  
  description string
  
  first_name object
  
  Hide first_name attributes Show first_name attributes object
  
  example string
  
  description string
  
  last_name object
  
  Hide last_name attributes Show last_name attributes object
  
  example string
  
  description string
  
  name object
  
  Hide name attributes Show name attributes object
  
  example string
  
  description string
  
  email object
  
  Hide email attributes Show email attributes object
  
  example string
  
  description string
  
  created_at string
  
  updated_at string
- tags array[object]
  
  Tags
  
  Hide tags attributes Show tags attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  slug string
  
  colour string
- owners array[object]
  
  Accounts that own this account
  
  Hide owners attributes Show owners attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string
- first_contact_date string
  
  First contact date
- next_review_date string
  
  Next review date
- previous_review_date string
  
  Previous review date
- anniversary_review_date string
  
  Anniversary review date
- with_login boolean
  
  Denotes whether the account has a login to Plannr
- has_joint_account boolean
  
  Denotes whether this account belongs to a joint account too
- can_be_deleted string
  
  Denotes if the account can be deleted
- joint_account_circle object
  
  This field is only present when viewing a joint account directly. This will contain the circle that we automatically created when we released circles.
  
  Hide joint_account_circle attributes Show joint_account_circle attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  photo_url string
  
  bg_colour string
  
  accounts string
  
  groups string
  
  joint_account_uuid string
  
  login_access_level string
  
  external_references string
- circles array[object]
  
  The circles the account belongs to
  
  Hide circles attributes Show circles attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  photo_url string
  
  bg_colour string
  
  accounts string
  
  groups string
  
  joint_account_uuid string
  
  login_access_level string
  
  external_references string
- ownership_percentage integer
  
  Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)
- inactive_at string
  
  Inactive from date
- custom_fields array[object]
  
  Any custom fields on the model.
  
  Hide custom_fields attributes Show custom_fields attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  name string
  
  reference string
  
  is_required boolean
  
  value string
  
  selection_options array[string]
  
  help_text string
- external_references array[object]
  
  The external references that have been added to the client.
  
  Hide external_references attributes Show external_references attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  third_party string
  
  reference string

POST /api/v1/client

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/client' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"title":"Mr","first_name":"Gareth","middle_name":"Alex","last_name":"Thompson","maiden_name":"Thompson","email":"gareth@codepotato.co.uk","phone":"443330509960","assigned_adviser_uuid":"cad1a382-b9df-4128-8a64-b6dc1ab2aa41","assigned_administrator_uuid":"4c2a43eb-f63a-457b-9d4a-212203b42402","assigned_paraplanner_uuid":"c98631d4-a79a-4a11-b363-23d1b22a3efb","introduced_by_uuid":"1f61569f-144d-4729-99a6-aa87782d8eb8","send_welcome_email":true,"date_of_birth":"1975-11-03","gender":"Male","ni_number":"AB 12 34 56 C","nickname":"G","target_retirement_age":60,"pronouns":"he/him","smoker_status":"non-smoker","residential_status":"settled","country_of_residence":"United Kingdom","marital_status":"married","is_vulnerable":"possibly","is_prospect":false,"prospect_converted_at":"2025-11-03T10:41:00+00:00","value":500000,"is_uk_resident":true,"is_uk_domicile":true,"expected_retirement_age":60,"state_retirement_age":60,"nationalities":["British","Romanian"],"vulnerability_details":"No vulnerabilities","third_party_offered":true,"procedure_adaptation":true,"adaption_details_notes":"Adaptation notes","client_preferences":"Prefers telephone calls in the morning.","current_state_of_health":"Fit and healthy","state_of_health_explanation":"Explanation of the current state of health.","cigarettes_daily":6,"smoker_since":"2015-11-03","long_term_care_needed":false,"long_term_care_notes":"Notes on the client's long term care.","has_will":false,"will_notes":"Notes on the client's will.","will_last_reviewed":"2025-11-02","has_power_of_attorney":true,"power_of_attorney_notes":"Notes on the client's power of attorney.","first_contact_date":"2025-10-03","units_of_alcohol_weekly":28,"height":186,"weight":220,"health_notes":"Notes on the client's health.","has_iht_planning":true,"iht_planning_notes":"Notes on the client's Inheritance Tax (IHT) planning.","has_gifted_family":true,"gift_notes":"Notes on the gifts.","is_anticipating_inheritance":true,"anticipating_inheritance_notes":"Notes on the client's inheritance anticipation/ expectations.","next_review_date":"2025-12-03","previous_review_date":"2025-10-03","anniversary_review_date":"2025-11-03","is_will_accurate":true,"will_executors":"string","will_location":"string","will_bequests_detail":"string","is_poa_registered_epa_or_lpa":"epa","are_poa_appointed_for_health_or_wealth":"health","poa_attorney_appointed_at":"2025-11-03T00:00:00+00:00","will_poa_details":"string","are_poa_documents_registered":true,"will_gifts_details":"string","groups":["f174a70d-0523-4b27-9c39-16d8cef0374b","a5091629-bb36-42fe-a0be-25852891b6fb"],"is_in_receipt_of_your_state_pension":true,"has_obtained_a_forecast":true,"date_of_forecast":"2025-11-03T10:41:00+00:00","projected_state_pension":50000,"years_of_national_insurance_contributions":5,"pension_notes":"string","status_uuid":"6210abb2-2420-4022-9d5b-2948547de2ce","date_of_marriage":"2025-11-03","is_deceased":false,"deceased_at":"2025-11-03","is_married_to_partner":true,"checked_sanctions_at":"2025-11-03","lead_source":"LeadGen Company","write_to_whom":"Gareth","passport_number":"123456","do_not_contact_via_fax":false,"do_not_contact_via_mail":false,"do_not_contact_via_sms":false,"do_not_contact_via_email":false,"do_not_contact_via_telephone":false,"do_not_visit":false,"do_not_market":false,"client_regulatory_classification":"professional_client","external_reference":[{"reference":"AB123456","third_party":"nucleus"}]}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "title": "Mr",
  "first_name": "Gareth",
  "middle_name": "Alex",
  "last_name": "Thompson",
  "maiden_name": "Thompson",
  "email": "gareth@codepotato.co.uk",
  "phone": "443330509960",
  "assigned_adviser_uuid": "cad1a382-b9df-4128-8a64-b6dc1ab2aa41",
  "assigned_administrator_uuid": "4c2a43eb-f63a-457b-9d4a-212203b42402",
  "assigned_paraplanner_uuid": "c98631d4-a79a-4a11-b363-23d1b22a3efb",
  "introduced_by_uuid": "1f61569f-144d-4729-99a6-aa87782d8eb8",
  "send_welcome_email": true,
  "date_of_birth": "1975-11-03",
  "gender": "Male",
  "ni_number": "AB 12 34 56 C",
  "nickname": "G",
  "target_retirement_age": 60,
  "pronouns": "he/him",
  "smoker_status": "non-smoker",
  "residential_status": "settled",
  "country_of_residence": "United Kingdom",
  "marital_status": "married",
  "is_vulnerable": "possibly",
  "is_prospect": false,
  "prospect_converted_at": "2025-11-03T10:41:00+00:00",
  "value": 500000,
  "is_uk_resident": true,
  "is_uk_domicile": true,
  "expected_retirement_age": 60,
  "state_retirement_age": 60,
  "nationalities": [
    "British",
    "Romanian"
  ],
  "vulnerability_details": "No vulnerabilities",
  "third_party_offered": true,
  "procedure_adaptation": true,
  "adaption_details_notes": "Adaptation notes",
  "client_preferences": "Prefers telephone calls in the morning.",
  "current_state_of_health": "Fit and healthy",
  "state_of_health_explanation": "Explanation of the current state of health.",
  "cigarettes_daily": 6,
  "smoker_since": "2015-11-03",
  "long_term_care_needed": false,
  "long_term_care_notes": "Notes on the client's long term care.",
  "has_will": false,
  "will_notes": "Notes on the client's will.",
  "will_last_reviewed": "2025-11-02",
  "has_power_of_attorney": true,
  "power_of_attorney_notes": "Notes on the client's power of attorney.",
  "first_contact_date": "2025-10-03",
  "units_of_alcohol_weekly": 28,
  "height": 186,
  "weight": 220,
  "health_notes": "Notes on the client's health.",
  "has_iht_planning": true,
  "iht_planning_notes": "Notes on the client's Inheritance Tax (IHT) planning.",
  "has_gifted_family": true,
  "gift_notes": "Notes on the gifts.",
  "is_anticipating_inheritance": true,
  "anticipating_inheritance_notes": "Notes on the client's inheritance anticipation/ expectations.",
  "next_review_date": "2025-12-03",
  "previous_review_date": "2025-10-03",
  "anniversary_review_date": "2025-11-03",
  "is_will_accurate": true,
  "will_executors": "string",
  "will_location": "string",
  "will_bequests_detail": "string",
  "is_poa_registered_epa_or_lpa": "epa",
  "are_poa_appointed_for_health_or_wealth": "health",
  "poa_attorney_appointed_at": "2025-11-03T00:00:00+00:00",
  "will_poa_details": "string",
  "are_poa_documents_registered": true,
  "will_gifts_details": "string",
  "groups": [
    "f174a70d-0523-4b27-9c39-16d8cef0374b",
    "a5091629-bb36-42fe-a0be-25852891b6fb"
  ],
  "is_in_receipt_of_your_state_pension": true,
  "has_obtained_a_forecast": true,
  "date_of_forecast": "2025-11-03T10:41:00+00:00",
  "projected_state_pension": 50000,
  "years_of_national_insurance_contributions": 5,
  "pension_notes": "string",
  "status_uuid": "6210abb2-2420-4022-9d5b-2948547de2ce",
  "date_of_marriage": "2025-11-03",
  "is_deceased": false,
  "deceased_at": "2025-11-03",
  "is_married_to_partner": true,
  "checked_sanctions_at": "2025-11-03",
  "lead_source": "LeadGen Company",
  "write_to_whom": "Gareth",
  "passport_number": "123456",
  "do_not_contact_via_fax": false,
  "do_not_contact_via_mail": false,
  "do_not_contact_via_sms": false,
  "do_not_contact_via_email": false,
  "do_not_contact_via_telephone": false,
  "do_not_visit": false,
  "do_not_market": false,
  "client_regulatory_classification": "professional_client",
  "external_reference": [
    {
      "reference": "AB123456",
      "third_party": "nucleus"
    }
  ]
}

Response examples (200)

{
  "firm": {
    "tax": 17.5,
    "logo": "https://api.plannrcrm.com/images/plannr.jpg",
    "name": "Codepotato",
    "slug": "codepotato",
    "uuid": "db53851d-12f7-49b4-906f-78c29a154687",
    "county": "Hampshire",
    "billing": {
      "invoice_email": "gareth@codepotato.co.uk",
      "invoice_county": "Hampshire",
      "invoice_country": "United Kingdom",
      "invoice_postcode": "PO7 7YH",
      "invoice_address_1": "Suite E, 5 The Briars",
      "invoice_address_2": "Waterberry Drive",
      "invoice_town_city": "Waterlooville"
    },
    "country": "United Kingdom",
    "postcode": "PO7 7YH",
    "address_1": "Suite E, 5 The Briars",
    "address_2": "Waterberry Drive",
    "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
    "month_end": 25,
    "town_city": "Waterlooville",
    "created_at": "2025-11-03T10:41:00+00:00",
    "updated_at": "2025-11-03T10:41:00+00:00",
    "ip_whitelist": [
      "192.168.0.1",
      "127.0.0.1"
    ],
    "brand_colours": {
      "sidebar_text": "#FFFFFF",
      "sidebar_hover": "#0A0A42",
      "email_sub_text": "#FFFFFF",
      "sidebar_accent": "#36367E",
      "sidebar_active": "#53DBB8",
      "email_background": "#0E0E56",
      "email_button_text": "#FFFFFF",
      "portal_background": "#F6F6F6",
      "portal_brand_title": "#323B4B",
      "sidebar_background": "#0E0E56",
      "portal_sidebar_icon": "#828994",
      "portal_sidebar_text": "#323B4B",
      "portal_sidebar_title": "#11151D",
      "sidebar_title_primary": "#FFC634",
      "portal_brand_sub_title": "#828994",
      "portal_sidebar_divider": "#E3E5E9",
      "email_button_background": "#36367E",
      "portal_dashboard_bg_one": "#EF4583",
      "portal_dashboard_bg_two": "#FFC634",
      "sidebar_title_secondary": "#FFFFFF",
      "sidebar_title_background": "#36367E",
      "portal_sidebar_icon_hover": "#828994",
      "portal_sidebar_text_hover": "#323B4B",
      "portal_sidebar_icon_active": "#828994",
      "portal_sidebar_text_active": "#323B4B",
      "email_logo_background_panel": "#36367E",
      "portal_sidebar_button_hover": "#FFFFFF",
      "portal_sidebar_account_email": "#828994",
      "portal_sidebar_account_title": "#11151D",
      "portal_sidebar_button_active": "#FFFFFF",
      "sidebar_title_secondary_hover": "#FFFFFF",
      "portal_sidebar_collapse_button": "#828994",
      "portal_sidebar_user_select_text": "#323B4B",
      "portal_sidebar_button_background": "#F6F6F6",
      "portal_sidebar_user_select_hover": "#F6F6F6",
      "portal_sidebar_user_select_border": "#EEEEEE",
      "portal_sidebar_collapse_button_hover": "#B3B9C4",
      "portal_sidebar_user_select_background": "#F6F6F6",
      "portal_sidebar_user_select_text_hover": "#323B4B",
      "portal_sidebar_user_select_border_hover": "#828994"
    },
    "is_subscribed": true,
    "regulatory_text": "Regulatory text",
    "cc_email_addresses": [
      "jack@example.com",
      "jill@example.com"
    ],
    "addon_subscriptions": "App\\Http\\Resources\\Addons\\AddonSubscriptionResource",
    "bcc_email_addresses": [
      "jack@example.com",
      "jill@example.com"
    ],
    "statement_frequency": "monthly",
    "task_board_template": "App\\Http\\Resources\\Board\\BoardResource",
    "keep_deleted_files_for": 30,
    "reply_to_email_address": "jack@example.com",
    "welcome_paragraph_html": "<h1>Welcome.</h1>",
    "email_welcome_paragraph_html": "Welcome to Plannr!",
    "show_fact_find_illustrations": true
  },
  "name": "Gareth Thompson",
  "role": "client",
  "tags": [
    {
      "name": "Mortgage",
      "slug": "mortgage",
      "uuid": "1bdb9cc9-cc06-4340-8b6e-3e32b76fb249",
      "colour": "#ef4582",
      "created_at": "2025-11-03T10:41:00+00:00",
      "updated_at": "2025-11-03T10:41:00+00:00"
    }
  ],
  "type": "client",
  "uuid": "f900bac6-5c49-40b5-b463-77fec40be9c5",
  "email": "gareth@codepotato.co.uk",
  "groups": [
    {
      "name": "finance",
      "slug": "finance",
      "uuid": "3fc5afaf-f556-41ae-b509-72816fdc5c5a",
      "created_at": "2025-11-03T10:41:00+00:00",
      "updated_at": "2025-11-03T10:41:00+00:00",
      "participants": {
        "name": {
          "example": "Gareth Thompson",
          "description": "Name of the account"
        },
        "role": {
          "example": "client",
          "description": "Role of the account"
        },
        "uuid": {
          "example": "6e182d04-2427-41e4-8018-f731977e1054",
          "description": "UUID of the account"
        },
        "email": {
          "example": "gareth@codepotato.co.uk",
          "description": "Email of the account"
        },
        "last_name": {
          "example": "Thompson",
          "description": "Last name of the account"
        },
        "first_name": {
          "example": "Gareth",
          "description": "First name of the account"
        }
      },
      "participants_count": "3"
    }
  ],
  "owners": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Gareth Thompson",
      "role": "client",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "client",
      "uuid": "c49d5deb-98bb-4629-84d4-e07e1b78b598",
      "email": "gareth@codepotato.co.uk",
      "groups": "App\\Http\\Resources\\GroupResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "circles": "App\\Http\\Resources\\CircleResource",
      "last_name": "Thompson",
      "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
      "created_at": "2025-11-03T10:41:00+00:00",
      "first_name": "Gareth",
      "updated_at": "2025-11-03T10:41:00+00:00",
      "with_login": true,
      "inactive_at": "2025-11-03",
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "introduced_by": "App\\Http\\Resources\\AccountResource",
      "primary_email": "App\\Http\\Resources\\ContactDetailResource",
      "can_be_deleted": "false",
      "assigned_adviser": "App\\Http\\Resources\\AccountResource",
      "next_review_date": "2025-11-03T10:41:00+00:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2025-11-03T10:41:00+00:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
      "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
      "joint_account_circle": "App\\Http\\Resources\\CircleResource",
      "ownership_percentage": 100,
      "previous_review_date": "2025-11-03T10:41:00+00:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2025-11-03T10:41:00+00:00"
    }
  ],
  "circles": [
    {
      "name": "Jones Family",
      "uuid": "dd4e097e-4fb0-4b5d-a6d2-d6405b9a9f05",
      "groups": "App\\Http\\Resources\\GroupResource",
      "accounts": "App\\Http\\Resources\\AccountResource",
      "bg_colour": "#35f4e1",
      "photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
      "created_at": "2025-11-03T10:41:00+00:00",
      "updated_at": "2025-11-03T10:41:00+00:00",
      "joint_account_uuid": "79158259-e812-4e06-82c4-263384a0310b",
      "login_access_level": "write",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
    }
  ],
  "last_name": "Thompson",
  "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
  "created_at": "2025-11-03T10:41:00+00:00",
  "first_name": "Gareth",
  "updated_at": "2025-11-03T10:41:00+00:00",
  "with_login": true,
  "inactive_at": "2025-11-03",
  "custom_fields": [
    {
      "name": "Favourite Drink",
      "type": "string",
      "uuid": "24b019c5-189c-4ee0-88f0-f87dfc110a89",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2025-11-03T10:41:00+00:00",
      "updated_at": "2025-11-03T10:41:00+00:00",
      "is_required": false,
      "selection_options": [
        "Coffee",
        "Tea",
        "Water"
      ]
    }
  ],
  "introduced_by": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "b8e1fa54-139e-40a3-8998-d6382ad8946f",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2025-11-03T10:41:00+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-11-03T10:41:00+00:00",
    "with_login": true,
    "inactive_at": "2025-11-03",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2025-11-03T10:41:00+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-11-03T10:41:00+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-11-03T10:41:00+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-11-03T10:41:00+00:00"
  },
  "primary_email": {
    "name": "Work number",
    "type": "phone_number",
    "uuid": "674f55b0-b0cf-4dc0-ab7d-d862ce1f420f",
    "value": "+443330903630",
    "accounts": "App\\Http\\Resources\\AccountResource",
    "created_at": "2025-11-03T10:41:00+00:00",
    "updated_at": "2025-11-03T10:41:00+00:00",
    "phone_number_meta": {
      "country": "GB",
      "formatted": "0333 090 3630"
    }
  },
  "can_be_deleted": "false",
  "assigned_adviser": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "07783e75-5c35-44fb-880a-f86c8b63acdc",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2025-11-03T10:41:00+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-11-03T10:41:00+00:00",
    "with_login": true,
    "inactive_at": "2025-11-03",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2025-11-03T10:41:00+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-11-03T10:41:00+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-11-03T10:41:00+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-11-03T10:41:00+00:00"
  },
  "next_review_date": "2025-11-03T10:41:00+00:00",
  "has_joint_account": true,
  "current_time_entry": {
    "name": "Research",
    "uuid": "e3ca5a80-dc15-4335-a990-9812dac74f61",
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "end_date": "2025-11-03T10:19:00+00:00",
    "is_active": true,
    "trackable": "App\\Http\\Resources\\MinimalAccountResource",
    "created_at": "2025-11-03T10:41:00+00:00",
    "start_date": "2025-11-03T09:51:00+00:00",
    "updated_at": "2025-11-03T10:41:00+00:00",
    "description": "This is a description.",
    "trackable_type": "Client",
    "total_time_in_minutes": 28,
    "computed_time_elapsed_in_seconds": 1680
  },
  "first_contact_date": "2025-11-03T10:41:00+00:00",
  "external_references": [
    {
      "uuid": "de820c86-287c-4d78-a7ee-8a19ee7f421f",
      "reference": "AB123456",
      "created_at": "2025-11-03T10:41:00+00:00",
      "updated_at": "2025-11-03T10:41:00+00:00",
      "third_party": "nucleus"
    }
  ],
  "assigned_paraplanner": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "49c4aae0-4363-40ea-b4b0-188457c5817b",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2025-11-03T10:41:00+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-11-03T10:41:00+00:00",
    "with_login": true,
    "inactive_at": "2025-11-03",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2025-11-03T10:41:00+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-11-03T10:41:00+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-11-03T10:41:00+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-11-03T10:41:00+00:00"
  },
  "joint_account_circle": {
    "name": "Jones Family",
    "uuid": "243cfb9d-b48e-4b67-938f-78856e5abca9",
    "groups": "App\\Http\\Resources\\GroupResource",
    "accounts": "App\\Http\\Resources\\AccountResource",
    "bg_colour": "#35f4e1",
    "photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
    "created_at": "2025-11-03T10:41:00+00:00",
    "updated_at": "2025-11-03T10:41:00+00:00",
    "joint_account_uuid": "c299136a-394f-42a3-97cc-0cfc87d69007",
    "login_access_level": "write",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "ownership_percentage": 100,
  "previous_review_date": "2025-11-03T10:41:00+00:00",
  "primary_phone_number": {
    "name": "Work number",
    "type": "phone_number",
    "uuid": "a3b63335-acb9-449d-8163-2f956b2c5da9",
    "value": "+443330903630",
    "accounts": "App\\Http\\Resources\\AccountResource",
    "created_at": "2025-11-03T10:41:00+00:00",
    "updated_at": "2025-11-03T10:41:00+00:00",
    "phone_number_meta": {
      "country": "GB",
      "formatted": "0333 090 3630"
    }
  },
  "assigned_administrator": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "a826e0c3-5aba-4f24-ae77-91224e7dd544",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2025-11-03T10:41:00+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-11-03T10:41:00+00:00",
    "with_login": true,
    "inactive_at": "2025-11-03",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2025-11-03T10:41:00+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-11-03T10:41:00+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-11-03T10:41:00+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-11-03T10:41:00+00:00"
  },
  "anniversary_review_date": "2025-11-03T10:41:00+00:00"
}