v1

latestSwagger 2.02026-08-047766481.4 KB

affordability

Get an existing affordability income calculation for a user

Requires affordability_income:read scope.

get/affordability/income/{reportId}

Path parameters

reportIdstring uuid required

The Report Id

Response

Successful Affordability Income Response

metaobject

Example response

{
  "data": {
    "createdAt": "2022-01-01T00:00:00Z",
    "id": "d372d09b-f50a-4114-9c83-687828fa8ac2",
    "income": {
      "amountConsistency": 1,
      "longevity": {
        "consecutiveIncomeMonths": 12,
        "incomePeriodLengthMonths": 12
      },
      "predicted": {
        "value": 189900,
        "majorUnits": 1899,
        "minorUnits": 0,
        "currency": "GBP"
      },
      "regularIncomeDetected": true
    },
    "overview": {
      "income": {
        "value": 189900,
        "majorUnits": 1899,
        "minorUnits": 0,
        "currency": "GBP"
      },
      "incomeIncludingTransfers": {
        "value": 210000,
        "majorUnits": 2100,
        "minorUnits": 0,
        "currency": "GBP"
      }
    },
    "primaryIncomeAccountId": "ac9bd177-d01e-449c-9f29-d3656d2edc2e"
  }
}