v1
latestSwagger 2.02026-08-047766481.4 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",
"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
},
"overdraftUseByAccount": [
{
"id": "ac9bd177-d01e-449c-9f29-d3656d2edc2e",
"daysInOverdraft": 4,
"daysInUnarrangedOverdraft": 2,
"earliestBalanceDate": "2022-01-01T00:00:00Z",
"details": [
{
"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,
"details": [
{
"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"
}
}
]
}
}
]
}
],
"overview": {
"discretionaryExpenses": {
"value": -55000,
"majorUnits": 550,
"minorUnits": 0,
"currency": "GBP"
},
"fixedExpenses": {
"value": -125000,
"majorUnits": 1250,
"minorUnits": 0,
"currency": "GBP"
},
"flexibleExpenses": {
"value": -59000,
"majorUnits": 590,
"minorUnits": 0,
"currency": "GBP"
},
"income": {
"value": 189900,
"majorUnits": 1899,
"minorUnits": 0,
"currency": "GBP"
},
"incomeIncludingTransfers": {
"value": 210000,
"majorUnits": 2100,
"minorUnits": 0,
"currency": "GBP"
},
"nonDiscretionaryExpenses": {
"value": -130000,
"majorUnits": 1300,
"minorUnits": 0,
"currency": "GBP"
}
},
"primaryIncomeAccountId": "ac9bd177-d01e-449c-9f29-d3656d2edc2e",
"riskIndicators": {
"cashWithdrawals": {
"value": -5000,
"majorUnits": 50,
"minorUnits": 0,
"currency": "GBP"
},
"gambling": {
"value": -2000,
"majorUnits": 20,
"minorUnits": 0,
"currency": "GBP"
},
"loansOpened": {
"byPeriod": {
"30days": {
"byType": {
"bnpl": 1,
"hcstc": 0,
"dca/dmp": 0,
"secured": 0,
"unknown": 0,
"unsecured": 0
},
"totalByType": {
"bnpl": {
"borrowed": {
"value": 100000,
"majorUnits": 1000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -10000,
"majorUnits": 100,
"minorUnits": 0,
"currency": "GBP"
}
},
"hcstc": {
"borrowed": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
}
},
"dca/dmp": {
"borrowed": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
}
},
"secured": {
"borrowed": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
}
},
"unknown": {
"borrowed": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
}
},
"unsecured": {
"borrowed": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
}
}
}
},
"90days": {
"byType": {
"bnpl": 2,
"hcstc": 0,
"dca/dmp": 1,
"secured": 0,
"unknown": 0,
"unsecured": 1
},
"totalByType": {
"bnpl": {
"borrowed": {
"value": 200000,
"majorUnits": 2000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -20000,
"majorUnits": 200,
"minorUnits": 0,
"currency": "GBP"
}
},
"hcstc": {
"borrowed": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
}
},
"dca/dmp": {
"borrowed": {
"value": 100000,
"majorUnits": 1000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -10000,
"majorUnits": 100,
"minorUnits": 0,
"currency": "GBP"
}
},
"secured": {
"borrowed": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
}
},
"unknown": {
"borrowed": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
}
},
"unsecured": {
"borrowed": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
}
}
}
},
"180days": {
"byType": {
"bnpl": 3,
"hcstc": 1,
"dca/dmp": 1,
"secured": 0,
"unknown": 0,
"unsecured": 1
},
"totalByType": {
"bnpl": {
"borrowed": {
"value": 300000,
"majorUnits": 3000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -30000,
"majorUnits": 300,
"minorUnits": 0,
"currency": "GBP"
}
},
"hcstc": {
"borrowed": {
"value": 100000,
"majorUnits": 1000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -10000,
"majorUnits": 100,
"minorUnits": 0,
"currency": "GBP"
}
},
"dca/dmp": {
"borrowed": {
"value": 100000,
"majorUnits": 1000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -10000,
"majorUnits": 100,
"minorUnits": 0,
"currency": "GBP"
}
},
"secured": {
"borrowed": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
}
},
"unknown": {
"borrowed": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
}
},
"unsecured": {
"borrowed": {
"value": 100000,
"majorUnits": 1000,
"minorUnits": 100,
"currency": "GBP"
},
"repaid": {
"value": -10000,
"majorUnits": 100,
"minorUnits": 0,
"currency": "GBP"
}
}
}
},
"365days": {
"byType": {
"bnpl": 3,
"hcstc": 1,
"dca/dmp": 2,
"secured": 0,
"unknown": 2,
"unsecured": 1
},
"totalByType": {
"bnpl": {
"borrowed": {
"value": 300000,
"majorUnits": 3000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -30000,
"majorUnits": 300,
"minorUnits": 0,
"currency": "GBP"
}
},
"hcstc": {
"borrowed": {
"value": 100000,
"majorUnits": 1000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -10000,
"majorUnits": 100,
"minorUnits": 0,
"currency": "GBP"
}
},
"dca/dmp": {
"borrowed": {
"value": 200000,
"majorUnits": 2000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -20000,
"majorUnits": 200,
"minorUnits": 0,
"currency": "GBP"
}
},
"secured": {
"borrowed": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": 0,
"majorUnits": 0,
"minorUnits": 0,
"currency": "GBP"
}
},
"unknown": {
"borrowed": {
"value": 200000,
"majorUnits": 2000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -20000,
"majorUnits": 200,
"minorUnits": 0,
"currency": "GBP"
}
},
"unsecured": {
"borrowed": {
"value": 100000,
"majorUnits": 1000,
"minorUnits": 0,
"currency": "GBP"
},
"repaid": {
"value": -10000,
"majorUnits": 100,
"minorUnits": 0,
"currency": "GBP"
}
}
}
}
}
},
"loanRepayments": {
"value": 4400,
"majorUnits": 44,
"minorUnits": 0,
"currency": "GBP"
},
"outgoingTransfers": {
"value": 20000,
"majorUnits": 200,
"minorUnits": 0,
"currency": "GBP"
},
"returnedDirectDebits": {
"count": 1,
"details": [
{
"category": "utilities",
"count": 1,
"period": {
"unit": "days",
"value": 30
},
"total": {
"returned": {
"value": 10000,
"majorUnits": 100,
"minorUnits": 0,
"currency": "GBP"
}
}
}
],
"periodMonths": 12
}
}
}
}