Risk Score
Risk Score provides a risk signal derived from customer transaction and account data. It is designed to support underwriting decisions by offering a consistent, explainable assessment of a customer’s probability of default over time.
Retrieving this report
Risk Score is returned as the risk entry of the report bundle - one call
returns it alongside Completeness and Aggregate. Check the entry's status before reading its
data; the fields below describe that data payload.
Read Completeness from the same bundle alongside Risk Score. Insufficient or gappy transaction data can reduce model accuracy and lower confidence in the output.
Interpreting results for credit
- Treat
valueandratingas one signal in a broader decision framework - always combine with Completeness and Aggregate from the same bundle - Use
shapleyValuesto understand which features drove the score, supporting audit trails and decision explainability - A null
valueor populatederrorCodesindicates the model did not have sufficient data - escalate these cases for manual assessment - Review
pdConfidenceRatingalongsiderating- a low confidence score means the result should be weighted accordingly
Response fields
Score and rating
| Field | Description |
|---|---|
value | Numeric risk score (probability of default). May be null if insufficient data is available |
rating | Risk band derived from the score, on a credit-style scale from strongest to weakest: BB+, BB, BB-, B+, B, B-, CCC, CC, D. null when no score could be produced |
pdConfidenceScore | Probability of default confidence score |
pdConfidenceRating | Named confidence band for the PD score |
Model features
The features object contains the input signals used by the risk model:
| Field | Description |
|---|---|
arb | Average running balance |
averageSales | Average sales or income amounts |
dishonourCount | Number of dishonoured transactions in the assessment period |
averageTaxPayment | Average tax payment amounts |
averageFinancialCount | Average count of financial transactions |
Explainability
| Field | Description |
|---|---|
shapleyValues | Map of feature names to their model contribution values. Use these to explain the key drivers of the risk score |
Transactions metadata
The transactionsMetadata object describes the data the score was calculated from:
| Field | Description |
|---|---|
earliestTransactionDate | Earliest transaction date used in the assessment |
latestTransactionDate | Latest transaction date used in the assessment |
transactionCount | Number of transactions used in the assessment |
Time series
The timeSeries object provides a temporal breakdown of the risk signal:
| Field | Description |
|---|---|
startDate | Start of the time series window |
endDate | End of the time series window |
frequency | Time interval for each data point |
windowDays | Size of the rolling window, in days |
values | Array of points, each with date, pd, rating, features, and warnings |
Error information
| Field | Description |
|---|---|
errorCodes | List of codes returned when the model cannot produce a score - for example, due to insufficient transaction volume |
Next steps
- Reports - How to retrieve this report and read its status
- Aggregate - Complement risk assessment with cashflow and affordability analysis
- Completeness - Review data coverage if the score is null or confidence is low
- API Reference - Full endpoint schema and parameter details