v1

latestOpenAPI 3.0.02026-07-2412592575.3 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",
    "requestedAt": "2021-12-31T23:00:00Z",
    "id": "d372d09b-f50a-4114-9c83-687828fa8ac2",
    "status": "complete",
    "income": {
      "amountConsistency": 1,
      "median": {
        "value": 189900,
        "majorUnits": 1899,
        "minorUnits": 0,
        "currency": "GBP"
      },
      "medianIncludingTransfers": {
        "value": 210000,
        "majorUnits": 2100,
        "minorUnits": 0,
        "currency": "GBP"
      },
      "primaryIncomeAccount": {
        "uid": "ac9bd177-d01e-449c-9f29-d3656d2edc2e"
      },
      "longevity": {
        "consecutiveIncome": {
          "months": 12
        },
        "incomePeriodLength": {
          "months": 12
        }
      },
      "regularIncome": {
        "isDetected": true,
        "predicted": {
          "monthly": {
            "amount": {
              "value": 189900,
              "majorUnits": 1899,
              "minorUnits": 0,
              "currency": "GBP"
            }
          }
        }
      },
      "categoriesUsed": [
        {
          "uid": "29",
          "key": "paychecks"
        }
      ]
    }
  }
}