Path parameters

• addon string Required
• account_uuid string Required

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
      • building_name string
      • 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