Path parameters

• addon string Required
• id string Required

  The ID of the client.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • id string

    The unique identifier of the client

  • node_id string

    The node ID

  • client_type string

    The type of client

  • title string

    The title of the client

  • first_name string

    The first name of the client

  • surname string

    The surname of the client

  • address_detail object

    The address details of the client

    Hide address_detail attributes Show address_detail attributes object

    • flat_number string
    • building_name string
    • building_number string
    • address_1 string
    • address_2 string
    • country string
    • postcode string
  • email string

    The email address of the client

  • mobile object

    The primary mobile number of the client

    Hide mobile attributes Show mobile attributes object

    • number string
    • locale string
    • isMobile boolean
  • nationality string

    The primary nationality of the client

  • national_insurance_no string

    The national insurance number of the client

  • date_of_birth string

    The date of birth of the client

  • tax_domicile string

    The tax domicile of the client

  • terms_accepted boolean

    The terms accepted status of the client

  • status string

    The status of the client

  • bank_details object

    The bank details of the client

    Hide bank_details attributes Show bank_details attributes object

    • account_number string
    • sort_code string
    • accepted_debit_mandate boolean
    • accepted_debit_mandate_at string
  • vulnerability object

    The vulnerability details of the client

    Hide vulnerability attributes Show vulnerability attributes object

    • isVulnerable boolean
    • reason array[string]
    • isSupportTemporary boolean
  • aml_passed boolean

    Whether the client has passed AML checks

  • requires_debit_mandate boolean

    Does this client require a debit mandate

  • employment_status string

    The employment status of the client

  • employers array[object]

    The employers of the client

    Hide employers attributes Show employers attributes object

    • companyName string
    • companyRegNo string
    • addressDetail object
      Hide addressDetail attributes Show addressDetail attributes object

      • flat_number string | null
      • building_name string | null
      • building_number string
      • address_1 string
      • address_2 string
      • country string
      • postcode string
    • bankDetails object
      Hide bankDetails attributes Show bankDetails attributes object

      • sortCode string
      • accountNumber string
  • marital_status string

    The marital status of the client

  • retirement_age integer

    The retirement age of the client

  • can_open_accounts_for array[string]

    The wrapper types the client can open accounts for

  • plannr_account object

    The Plannr account associated with the client

    Hide plannr_account attributes Show plannr_account 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
    • business_unit 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
    • last_interaction_at string
    • referral_code string
    • permissions object
      Hide permissions attributes Show permissions attributes object

      • firm:read array[string]
      • network:read array[string]
    • custom_fields string
    • external_references string
  • parent_id string

    The parent ID of the client