v3

latestOpenAPI 3.0.0MITraw.githubusercontent.com2018-07-27163.4 KB

perform the income proving test

post/incomeproving/v2/individual/financialstatus

Request body

applicationRaisedDatestring required
dependantsinteger required

Example request

{
  "applicationRaisedDate": "2018-06-18",
  "dependants": 2,
  "individuals": [
    {
      "forename": "Bilbo",
      "surname": "Baggins",
      "nino": "BB123456B",
      "dateOfBirth": "1800-05-13"
    }
  ]
}

Response

OK

Example response

{
  "individuals": [
    {
      "forename": "Bilbo",
      "surname": "Baggins",
      "nino": "BB123456B",
      "dateOfBirth": "1800-05-13"
    }
  ],
  "categoryChecks": [
    {
      "calculationType": "A",
      "passed": true,
      "applicationRaisedDate": "2018-06-18",
      "assessmentStartDate": "2018-06-10",
      "failureReason": "Something went wrong",
      "threshold": "1550.00",
      "individuals": [
        {
          "nino": "BB123456B",
          "employers": [
            "Pizza Hut"
          ]
        }
      ]
    }
  ]
}
All 1 operations