v1
latestOpenAPI 3.0.02026-07-2412592575.3 KBaffordability
Get an existing affordability calculation for a user
Requires affordability:read scope.
get/affordability/{reportId}
Path parameters
reportIdstring uuid required
The Report Id
Response
Successful Affordability Response
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"
}
]
},
"expenditure": {
"discretionary": {
"median": {
"value": -55000,
"majorUnits": 550,
"minorUnits": 0,
"currency": "GBP"
}
},
"fixed": {
"median": {
"value": -125000,
"majorUnits": 1250,
"minorUnits": 0,
"currency": "GBP"
}
},
"flexible": {
"median": {
"value": -59000,
"majorUnits": 590,
"minorUnits": 0,
"currency": "GBP"
}
},
"nonDiscretionary": {
"median": {
"value": -130000,
"majorUnits": 1300,
"minorUnits": 0,
"currency": "GBP"
}
},
"cashWithdrawals": {
"median": {
"value": -5000,
"majorUnits": 50,
"minorUnits": 0,
"currency": "GBP"
}
}
},
"overdrafts": {
"usage": {
"details": [
{
"accountUid": "ac9bd177-d01e-449c-9f29-d3656d2edc2e",
"daysInOverdraft": 4,
"daysInUnarrangedOverdraft": 2,
"earliestBalanceDate": "2022-01-01T00:00:00Z",
"periodsInOverdraft": [
{
"days": 4,
"start": "2022-01-01T00:00:00Z",
"end": "2022-01-05T00:00:00Z",
"minimumBalance": {
"value": -10000,
"majorUnits": 100,
"minorUnits": 0,
"currency": "GBP"
},
"unarrangedOverdraft": {
"days": 2,
"periods": [
{
"days": 1,
"start": "2022-01-01T00:00:00Z",
"end": "2022-01-02T00:00:00Z",
"minimumBalance": {
"value": -10000,
"majorUnits": 100,
"minorUnits": 0,
"currency": "GBP"
}
},
{
"days": 1,
"start": "2022-01-04T00:00:00Z",
"end": "2022-01-05T00:00:00Z",
"minimumBalance": {
"value": -9900,
"majorUnits": 99,
"minorUnits": 0,
"currency": "GBP"
}
}
]
}
}
]
}
]
}
},
"gambling": {
"out": {
"median": {
"value": -2000,
"majorUnits": 20,
"minorUnits": 0,
"currency": "GBP"
}
}
},
"transfers": {
"median": {
"value": -20000,
"majorUnits": 200,
"minorUnits": 0,
"currency": "GBP"
},
"out": {
"median": {
"value": -20000,
"majorUnits": 200,
"minorUnits": 0,
"currency": "GBP"
}
}
},
"returnedPayments": {
"count": 1,
"details": [
{
"category": "utilities",
"count": 1,
"period": {
"unit": "days",
"value": 30
},
"total": {
"returned": {
"value": 10000,
"majorUnits": 100,
"minorUnits": 0,
"currency": "GBP"
}
}
}
],
"period": {
"months": 12
}
},
"loans": {
"repayments": {
"median": {
"value": -20000,
"majorUnits": 200,
"minorUnits": 0,
"currency": "GBP"
}
},
"opened": {
"details": [
{
"count": 1,
"period": {
"unit": "days",
"value": 30
},
"total": {
"borrowed": {
"value": 100000,
"majorUnits": 1000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -10000,
"majorUnits": 100,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "bnpl"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 90
},
"total": {
"borrowed": {
"value": 200000,
"majorUnits": 2000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -20000,
"majorUnits": 200,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "bnpl"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 180
},
"total": {
"borrowed": {
"value": 300000,
"majorUnits": 3000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -30000,
"majorUnits": 300,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "bnpl"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 365
},
"total": {
"borrowed": {
"value": 300000,
"majorUnits": 3000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -30000,
"majorUnits": 300,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "bnpl"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 30
},
"total": {
"borrowed": {
"value": 100000,
"majorUnits": 1000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -10000,
"majorUnits": 100,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "hcstc"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 90
},
"total": {
"borrowed": {
"value": 200000,
"majorUnits": 2000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -20000,
"majorUnits": 200,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "hcstc"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 180
},
"total": {
"borrowed": {
"value": 300000,
"majorUnits": 3000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -30000,
"majorUnits": 300,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "hcstc"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 365
},
"total": {
"borrowed": {
"value": 300000,
"majorUnits": 3000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -30000,
"majorUnits": 300,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "hcstc"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 30
},
"total": {
"borrowed": {
"value": 100000,
"majorUnits": 1000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -10000,
"majorUnits": 100,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "dca/dmp"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 90
},
"total": {
"borrowed": {
"value": 200000,
"majorUnits": 2000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -20000,
"majorUnits": 200,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "dca/dmp"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 180
},
"total": {
"borrowed": {
"value": 300000,
"majorUnits": 3000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -30000,
"majorUnits": 300,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "dca/dmp"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 365
},
"total": {
"borrowed": {
"value": 300000,
"majorUnits": 3000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -30000,
"majorUnits": 300,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "dca/dmp"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 30
},
"total": {
"borrowed": {
"value": 100000,
"majorUnits": 1000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -10000,
"majorUnits": 100,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "secured"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 90
},
"total": {
"borrowed": {
"value": 200000,
"majorUnits": 2000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -20000,
"majorUnits": 200,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "secured"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 180
},
"total": {
"borrowed": {
"value": 300000,
"majorUnits": 3000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -30000,
"majorUnits": 300,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "secured"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 365
},
"total": {
"borrowed": {
"value": 300000,
"majorUnits": 3000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -30000,
"majorUnits": 300,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "secured"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 30
},
"total": {
"borrowed": {
"value": 100000,
"majorUnits": 1000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -10000,
"majorUnits": 100,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "unknown"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 90
},
"total": {
"borrowed": {
"value": 200000,
"majorUnits": 2000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -20000,
"majorUnits": 200,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "unknown"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 180
},
"total": {
"borrowed": {
"value": 300000,
"majorUnits": 3000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -30000,
"majorUnits": 300,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "unknown"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 365
},
"total": {
"borrowed": {
"value": 300000,
"majorUnits": 3000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -30000,
"majorUnits": 300,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "unknown"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 30
},
"total": {
"borrowed": {
"value": 100000,
"majorUnits": 1000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -10000,
"majorUnits": 100,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "unsecured"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 90
},
"total": {
"borrowed": {
"value": 200000,
"majorUnits": 2000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -20000,
"majorUnits": 200,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "unsecured"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 180
},
"total": {
"borrowed": {
"value": 300000,
"majorUnits": 3000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -30000,
"majorUnits": 300,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "unsecured"
},
{
"count": 1,
"period": {
"unit": "days",
"value": 365
},
"total": {
"borrowed": {
"value": 300000,
"majorUnits": 3000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -30000,
"majorUnits": 300,
"minorUnits": 0,
"currency": "GBP"
}
},
"type": "unsecured"
}
]
}
}
}
}