Quickli API
IndexAuthOld ScenarioLIXI ScenarioFunds PositionExamples

API Schema Documentation

Bare minimum LIXI schema payload to get the API working
{
  "content": {
    "application": {
      "household": [
        {
          "uniqueID": "Family_7277208"
        }
      ],
      "liability": [],
      "loanDetails": [
        {
          "uniqueID": "LoanStructure_5882474"
        }
      ],
      "otherIncome": [],
      "personApplicant": [
        {
          "uniqueID": "Family_8732265",
          "x_Household": "Family_7277208"
        }
      ],
      "realEstateAsset": [],
      "relatedCompany": []
    }
  }
}
Bare minimum LIXI schema payload to get a valid scenario in the Quickli UI
{
  "content": {
    "application": {
      "household": [
        {
          "uniqueID": "Family_7277208"
        }
      ],
      "liability": [],
      "loanDetails": [
        {
          "uniqueID": "LoanStructure_5882474",
          "amountRequested": 500000,
          "lvr": 80,
          "term": {
            "totalTermDuration": 30,
            "totalTermUnit": "Year"
          }
        }
      ],
      "otherIncome": [],
      "personApplicant": [
        {
          "uniqueID": "Family_8732265",
          "x_Household": "Family_7277208",
          "employment": [
            {
              "payg": {
                "x_Employer": "Employer_49204359",
                "status": "Primary",
                "income": {
                  "grossSalaryAmount": 100000,
                  "grossSalaryFrequency": "Yearly"
                }
              }
            }
          ]
        }
      ],
      "realEstateAsset": [],
      "relatedCompany": []
    }
  }
}