Get client options

GET /api/v2/clients/options
Bearer auth

This endpoint provides a comprehensive list of valid options for each field. The response example displayed is only a summarised version of the actual list. By using this endpoint, a complete list of available options for each field can be retrieved.

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • success boolean

      Default value is true.

    • data object
      Hide data attributes Show data attributes object
      • Gender object
        Hide Gender attributes Show Gender attributes object
        • 1 string

          Value is Male.

        • 2 string

          Value is Female.

        • 3 string

          Value is Other.

      • AddressCountryCode object
        Hide AddressCountryCode attributes Show AddressCountryCode attributes object
        • 4 string

          Value is Afghanistan.

        • 8 string

          Value is Albania.

        • 10 string

          Value is Antarctica.

      • MaritalStatus object
        Hide MaritalStatus attributes Show MaritalStatus attributes object
        • 1 string

          Value is Single.

        • 2 string

          Value is Married.

        • 3 string

          Value is Divorced.

      • IncomeTaxArea object
        Hide IncomeTaxArea attributes Show IncomeTaxArea attributes object
        • 1 string

          Value is UK excluding Scotland.

        • 2 string

          Value is Scotland.

        • 3 string

          Value is Other.

        • 4 string

          Value is All at 20%.

        • 5 string

          Value is No Tax Applied.

      • AdviserID object
        Hide AdviserID attributes Show AdviserID attributes object
        • 100 string

          Value is Tom Smith.

        • 200 string

          Value is Jack Jones.

        • 300 string

          Value is John Adams.

      • AttitudeToRiskLevel object
        Hide AttitudeToRiskLevel attributes Show AttitudeToRiskLevel attributes object
        • 17 string

          Value is Cautious.

        • 18 string

          Value is Medium.

        • 19 string

          Value is Adventurous.

      • ClientTier object
        Hide ClientTier attributes Show ClientTier attributes object
        • 17 string

          Value is Ongoing Advice Clients.

        • 18 string

          Value is Adhoc Advice Clients.

      • EmploymentStatus object
        Hide EmploymentStatus attributes Show EmploymentStatus attributes object
        • 1 string

          Value is Employed.

        • 2 string

          Value is Self-Employed.

        • 3 string

          Value is Not Employed.

      • OccupationCode object
        Hide OccupationCode attributes Show OccupationCode attributes object
      • RetirementPlanned object
        Hide RetirementPlanned attributes Show RetirementPlanned attributes object
        • 1 string

          Value is Age.

        • 2 string

          Value is Date.

      • MarriageAllowance object
        Hide MarriageAllowance attributes Show MarriageAllowance attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

      • FinancialDependenceAge object
        Hide FinancialDependenceAge attributes Show FinancialDependenceAge attributes object
        • 1 string

          Value is Not Applicable.

        • 2 string

          Value is 18.

        • 3 string

          Value is 21.

      • MPAATriggered object
        Hide MPAATriggered attributes Show MPAATriggered attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

      • LTAAppliedFor object
        Hide LTAAppliedFor attributes Show LTAAppliedFor attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

      • LTAProtectionType object
        Hide LTAProtectionType attributes Show LTAProtectionType attributes object
        • 1 string

          Value is Enhanced Protection.

        • 2 string

          Value is Primary Protection.

        • 3 string

          Value is Fixed Protection 2012.

      • LTAProtectedLumpSum object
        Hide LTAProtectedLumpSum attributes Show LTAProtectedLumpSum attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

      • LTAPrevBCEs object
        Hide LTAPrevBCEs attributes Show LTAPrevBCEs attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

      • AddressCounty object
        Hide AddressCounty attributes Show AddressCounty attributes object
GET /api/v2/clients/options 
curl \
 -X GET https://api.fincalc.co.uk/api/v2/clients/options \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "success": true,
  "data": {
    "Gender": {
      "1": "Male",
      "2": "Female",
      "3": "Other"
    },
    "AddressCountryCode": {
      "4": "Afghanistan",
      "8": "Albania",
      "10": "Antarctica"
    },
    "MaritalStatus": {
      "1": "Single",
      "2": "Married",
      "3": "Divorced"
    },
    "IncomeTaxArea": {
      "1": "UK excluding Scotland",
      "2": "Scotland",
      "3": "Other",
      "4": "All at 20%",
      "5": "No Tax Applied"
    },
    "AdviserID": {
      "100": "Tom Smith",
      "200": "Jack Jones",
      "300": "John Adams"
    },
    "AttitudeToRiskLevel": {
      "17": "Cautious",
      "18": "Medium",
      "19": "Adventurous"
    },
    "ClientTier": {
      "17": "Ongoing Advice Clients",
      "18": "Adhoc Advice Clients"
    },
    "EmploymentStatus": {
      "1": "Employed",
      "2": "Self-Employed",
      "3": "Not Employed"
    },
    "OccupationCode": {
      "AAB00001": "Abattoir Inspector",
      "AAC02588": "Abattoir Worker",
      "AAD03000": "Abrasive Wheels Worker"
    },
    "RetirementPlanned": {
      "1": "Age",
      "2": "Date"
    },
    "MarriageAllowance": {
      "1": "Yes",
      "2": "No"
    },
    "FinancialDependenceAge": {
      "1": "Not Applicable",
      "2": "18",
      "3": "21"
    },
    "MPAATriggered": {
      "1": "Yes",
      "2": "No"
    },
    "LTAAppliedFor": {
      "1": "Yes",
      "2": "No"
    },
    "LTAProtectionType": {
      "1": "Enhanced Protection",
      "2": "Primary Protection",
      "3": "Fixed Protection 2012"
    },
    "LTAProtectedLumpSum": {
      "1": "Yes",
      "2": "No"
    },
    "LTAPrevBCEs": {
      "1": "Yes",
      "2": "No"
    },
    "AddressCounty": {
      "Aberdeenshire": "Aberdeenshire",
      "Anglesey": "Anglesey",
      "Alderney": "Alderney"
    }
  }
}