# Create a client [DEPRECATED: Use create an account route] **POST /api/v1/client** ## Servers - https://api.plannrcrm.com: https://api.plannrcrm.com () ## Authentication methods - Personal access token & O auth2 ## Parameters #### Headers - **X-PLANNR-ACCOUNT-UUID** (string) ## Body parameters Content-type: application/json - **title** (string) Title - **first_name** (string) First Name - **middle_name** (string) Middle Name - **last_name** (string) 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) 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: #### Body Parameters: application/json (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 - **primary_phone_number** (object) Primary phone number - **primary_email** (object) Primary email - **current_time_entry** (object) Current time entry - **assigned_adviser** (object) Assigned adviser - **assigned_administrator** (object) Assigned administrator - **assigned_paraplanner** (object) Assigned paraplanner - **introduced_by** (object) Introduced by - **groups** (array[object]) Groups - **tags** (array[object]) Tags - **owners** (array[object]) Accounts that own this account - **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. - **circles** (array[object]) The circles the account belongs to - **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. - **external_references** (array[object]) The external references that have been added to the client. [Powered by Bump.sh](https://bump.sh)