Body

• Title string | null

  The following characters are not permitted: \:*"<>|

  Maximum length is 20.

• FirstName string Required

  The following characters are not permitted: \:*"<>|

  Minimum length is 2, maximum length is 50.

• Surname string Required

  The following characters are not permitted: \:*"<>|

  Maximum length is 50.

• KnownAs string | null

  The following characters are not permitted: \:*"<>|

  Maximum length is 50.

• Gender integer Required

  An integer representing the gender of the client:

  • 1: Male
  • 2: Female
  • 3: Other
• EmailAddress string(email) | null

  Maximum length is 64.

• Mobile string | null

  Maximum length is 20.

• DateOfBirth string(date) Required

  Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023. The response will contain an object of formatted values where the date will in the format "d/m/Y".

• MaritalStatus integer | null

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options

• MarriageAllowance integer | null

  An integer representing the status of the clients marriage allowance:

  • 1: Yes
  • 2: No
• NINumber string | null
• EmploymentStatus integer | null

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options

• OccupationCode string | null

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options

  Maximum length is 8.

• RetirementPlanned integer | null

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options

  This field is required if the value of EmploymentStatus = 1, 2, 3, 4 or 6.

• RetirementDate string(date) | null

  This field is required if the value of EmploymentStatus = 1, 2, 3, 4 or 6 and the value of RetirementPlanned = 2. Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023. The response will contain an object of formatted values where the date will in the format "d/m/Y".

• RetirementAge integer | null

  This field is required if the value of EmploymentStatus = 1, 2, 3, 4 or 6 and the value of RetirementPlanned = 1.

  Minimum value is 0, maximum value is 130.

• AddressCountryCode integer | null

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options

• AddressLine1 string | null

  The following characters are not permitted: \:*"<>|

  Maximum length is 50.

• AddressLine2 string | null

  The following characters are not permitted: \:*"<>|

  Maximum length is 50.

• AddressLine3 string | null

  The following characters are not permitted: \:*"<>|

  Maximum length is 50.

• AddressLine4 string | null

  The following characters are not permitted: \:*"<>|

  Maximum length is 50.

• AddressTown string | null

  The following characters are not permitted: \:*"<>|

  Maximum length is 50.

• AddressCounty string | null

  Maximum length is 50.

• AddressPostCode string | null

  The following characters are not permitted: \:*"<>|

  Maximum length is 20.

• IncomeTaxArea integer | null

  An integer representing the clients income tax area:

  • 1: UK excluding Scotland
  • 2: Scotland
  • 3: Other
  • 4: All at 20%
  • 5: No Tax Applied
• AdviserID integer | null

  This field is required if the user company is different to primary company (user is logged into a network company) or if the company has had the adviser field enforced.

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options

• Reference string | null

  Maximum length is 50.

• AttitudeToRiskLevel integer | null

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options

• ClientTier integer | null

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options

• FinancialDependenceAge integer | null

  To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options

• AddressFrom string(date) | null

  Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023. The response will contain an object of formatted values where the date will in the format "d/m/Y".

• NextReviewDate string(date) | null

  Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023. The response will contain an object of formatted values where the date will in the format "d/m/Y".

• LTA object

  Additional properties are allowed.

  Hide LTA attributes Show LTA attributes object

  • MPAATriggered integer | null

    An integer representing the status of the clients MPAA:

    • 1: Yes
    • 2: No
  • MpaTriggerDate string(date)

    Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023. The response will contain an object of formatted values where the date will in the format "d/m/Y". Date should be before or equal to today.

  • LTAHMRCertificateValue number(float) | null

    This field is required if any of the following conditions are met:

    • The value of LTAProtectionType = 4 and the value of LTAAppliedFor = 1.
    • The value of LTAProtectionType = 6 and the value of LTAAppliedFor = 1.

    If the value of LTAProtectionType is 4: - LTAHMRCertificateValue must be greater than £1,250,000. - LTAHMRCertificateValue must be less than or equal to £1,500,000.

    If the value of LTAProtectionType is 6: - LTAHMRCertificateValue must be greater than £1,000,000. - LTAHMRCertificateValue must be less than or equal to £1,250,000.

  • LTAProtectedCashAmount number(float) | null

    This field is required if the value of LTAProtectionType = 2 and the value of LTAProtectedLumpSum = 1 LTAProtectedCashAmount must be greater than 0.

    Minimum value is 1.

  • LTAProtectedCashPercentage number(float) | null

    This field is required if the value of LTAProtectionType = 1 and the value of LTAProtectedLumpSum = 1 LTAProtectedCashPercentage must be greater than 0.

    Minimum value is 1.

  • LTAPrevBCEs integer | null

    This field is required if any of the following conditions are met:

    • The value of LTAProtectionType = 2
    • The value of LTAProtectionType = 1 and the value of LTAProtectedLumpSum = 2.
  • LTAPercentageLeft number(float) | null

    Minimum value is 0, maximum value is 100.

  • LTAAppliedFor integer | null

    An integer representing weather or not the client has HMRC protection:

    • 1: Yes
    • 2: No
  • LTAProtectionType integer | null

    To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/clients/options This field is required if the value of LTAAppliedFor = 1.

  • LTAEnhancementFactor number(float) | null

    This field is required if the value of LTAProtectionType = 2.

  • LTAProtectedLumpSum integer | null

    An integer representing the clients protected lump sum rights:

    • 1: Yes
    • 2: No

    This field is required if any of the following conditions are met:

    • The value of LTAProtectionType = 1
    • The value of LTAProtectionType = 2
  • InheritedNilRateBand number(float) | null
  • InheritedResidenceNilRateBand number(float) | null
  • TaxFreeCash array[object]

    This field is required if any of the following conditions are met:

    • The value of LTAProtectionType = 2 and the value of LTAProtectedLumpSum = 1 and the value of LTAPrevBCEs = 1.
    • The value of LTAProtectionType = 1 and the value of LTAProtectedLumpSum = 2 and the value of LTAPrevBCEs = 1.
    • The value of LTAProtectionType = 2 and the value of LTAProtectedLumpSum = 2 and the value of LTAPrevBCEs = 1.

    An array of objects representing multiple rows of tax-free cash data. Each object should have the following properties: - BCEDate: a date string in the format yyyy-mm-dd. Duplication of BCEDate is not permitted. - BCEAmount: an integer representing the BCE amount. - BCETFC: an integer representing the BCE tax-free cash amount. (Not required if LTAProtectionType = 1 or 2 and LTAProtectedLumpSum = 2)

    Updating the array will overwrite any existing data for that client, therefore if adding new rows to the array, data for existing rows should be included in the request.

    Additional properties are allowed.