Get liability options

GET /api/v2/household/{HouseholdGUID}/liabilities/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.

Path parameters

  • HouseholdGUID string(uuid) Required

    The GUID of the household you wish to get options for.

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
      • LiabilityType object
        Hide LiabilityType attributes Show LiabilityType attributes object
        • 1 string

          Value is Repayment Mortgage.

        • 6 string

          Value is Interest Only Mortgage.

        • 5 string

          Value is Equity Release.

      • StartBasis object
        Hide StartBasis attributes Show StartBasis attributes object
        • 1 string

          Value is Current.

        • 2 string

          Value is Specific Age.

        • 3 string

          Value is Specific Date.

      • StartEventGUID object
        Hide StartEventGUID attributes Show StartEventGUID attributes object
        • 8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B string

          Value is Tony's State Pension Age.

        • 1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P string

          Value is Tina's State Pension Age.

        • E8F8B580-0D24-45B7-9DA1-8F11F64B6909 string

          Value is Tina's Birthday.

      • EndBasis object
        Hide EndBasis attributes Show EndBasis attributes object
        • 2 string

          Value is Specific Age.

        • 3 string

          Value is Specific Date.

        • 4 string

          Value is Event.

      • EndEventGUID object
        Hide EndEventGUID attributes Show EndEventGUID attributes object
        • 8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B string

          Value is Tony's State Pension Age.

        • 1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P string

          Value is Tina's State Pension Age.

        • E8F8B580-0D24-45B7-9DA1-8F11F64B6909 string

          Value is Tina's Birthday.

      • Providercode object
        Hide Providercode attributes Show Providercode attributes object
        • 00028d6f-3ccf-e011-87a9-b8ac6f1693a8 string

          Value is Life Assurance Corporation of India.

        • 001ee90c-3dcf-e011-87a9-b8ac6f1693a8 string

          Value is Toluna Plc.

        • 002c2f7c-3bcf-e011-87a9-b8ac6f1693a8 string

          Value is Standard Life Investments.

      • ClearLiabilityAtEnd object
        Hide ClearLiabilityAtEnd attributes Show ClearLiabilityAtEnd attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

      • InterestRateChange object
        Hide InterestRateChange attributes Show InterestRateChange attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

      • InterestRateChangeBasis object
        Hide InterestRateChangeBasis attributes Show InterestRateChangeBasis attributes object
        • 2 string

          Value is Specific Age.

        • 3 string

          Value is Specific Date.

        • 4 string

          Value is Event.

      • InterestRateChangeEventGUID object
        Hide InterestRateChangeEventGUID attributes Show InterestRateChangeEventGUID attributes object
        • 8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B string

          Value is Tony's State Pension Age.

        • 1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P string

          Value is Tina's State Pension Age.

        • E8F8B580-0D24-45B7-9DA1-8F11F64B6909 string

          Value is Tina's Birthday.

      • LinkedAssetGUID object
        Hide LinkedAssetGUID attributes Show LinkedAssetGUID attributes object
        • 8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B string

          Value is Our House.

        • 1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P string

          Value is Our Boat.

        • E8F8B580-0D24-45B7-9DA1-8F11F64B6909 string

          Value is Rental Property.

      • BackOfficeSync object
        Hide BackOfficeSync attributes Show BackOfficeSync attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

        • 3 string

          Value is Only update from back office.

      • CalculatedRepayment object
        Hide CalculatedRepayment attributes Show CalculatedRepayment attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is Yes.
  • 403 application/json

    Permission error.

    Hide response attributes Show response attributes object
    • success boolean

      Default value is false.

    • message string
  • 404 application/json

    Household not found

    Hide response attributes Show response attributes object
    • success boolean

      Default value is false.

    • message string
GET /api/v2/household/{HouseholdGUID}/liabilities/options 
curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/liabilities/options' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "success": true,
  "data": {
    "LiabilityType": {
      "1": "Repayment Mortgage",
      "6": "Interest Only Mortgage",
      "5": "Equity Release"
    },
    "StartBasis": {
      "1": "Current",
      "2": "Specific Age",
      "3": "Specific Date"
    },
    "StartEventGUID": {
      "8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B": "Tony's State Pension Age",
      "1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P": "Tina's State Pension Age",
      "E8F8B580-0D24-45B7-9DA1-8F11F64B6909": "Tina's Birthday"
    },
    "EndBasis": {
      "2": "Specific Age",
      "3": "Specific Date",
      "4": "Event"
    },
    "EndEventGUID": {
      "8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B": "Tony's State Pension Age",
      "1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P": "Tina's State Pension Age",
      "E8F8B580-0D24-45B7-9DA1-8F11F64B6909": "Tina's Birthday"
    },
    "Providercode": {
      "00028d6f-3ccf-e011-87a9-b8ac6f1693a8": "Life Assurance Corporation of India",
      "001ee90c-3dcf-e011-87a9-b8ac6f1693a8": "Toluna Plc",
      "002c2f7c-3bcf-e011-87a9-b8ac6f1693a8": "Standard Life Investments"
    },
    "ClearLiabilityAtEnd": {
      "1": "Yes",
      "2": "No"
    },
    "InterestRateChange": {
      "1": "Yes",
      "2": "No"
    },
    "InterestRateChangeBasis": {
      "2": "Specific Age",
      "3": "Specific Date",
      "4": "Event"
    },
    "InterestRateChangeEventGUID": {
      "8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B": "Tony's State Pension Age",
      "1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P": "Tina's State Pension Age",
      "E8F8B580-0D24-45B7-9DA1-8F11F64B6909": "Tina's Birthday"
    },
    "LinkedAssetGUID": {
      "8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B": "Our House",
      "1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P": "Our Boat",
      "E8F8B580-0D24-45B7-9DA1-8F11F64B6909": "Rental Property"
    },
    "BackOfficeSync": {
      "1": "Yes",
      "2": "No",
      "3": "Only update from back office"
    },
    "CalculatedRepayment": {
      "1": "Yes",
      "2": "Yes"
    }
  }
}
Response examples (403) 
{
  "success": false,
  "message": "You do not have permission to view the household."
}
Response examples (404) 
{
  "success": false,
  "message": "Household not found."
}