Score endpoint
Submit an application for scoring and receive a full credit assessment.
POST /v1/score
Submit an application for scoring. Returns score, tier, recommendation, and SHAP contributions.
Request fields
| Field | Type | Description |
|---|---|---|
mobile_money_months | number | Length of mobile money account history, in months |
monthly_inflow | number | Average monthly inflow across mobile money accounts |
stability_score | number (0–1) | Consistency of inflow over the observed period |
airtime_regularity | number (0–1) | Regularity of airtime top-up behavior |
Response
{
"credit_score": 712,
"risk_tier": "B",
"default_probability": 0.06,
"recommended_limit": 85000,
"recommended_term_days": 270,
"recommended_rate": 14,
"shap": [
{ "feature": "mobile_money_months", "contribution": 0.14 },
{ "feature": "stability_score", "contribution": 0.09 }
]
}Errors
| Code | Meaning |
|---|---|
400 | Missing required fields or invalid data types |
401 | Invalid or expired API key |
429 | Rate limit exceeded — see the Retry-After header |
500 | Internal error — logged and alerted on immediately |