API reference
Integrate credit scoring into your platform
The AfriScore API accepts alternative data fields and returns a calibrated credit score, risk tier, recommended loan terms, and SHAP explainability — designed for sub-200ms response times in production.
Quickstart
Your first API call, illustrated below. Live keys are issued after pilot onboarding.
curl -X POST https://afriscore.africa/api/v1/score \
-H "Authorization: Bearer $AFRISCORE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"mm_months": 18,
"avg_inflow": 1200,
"avg_outflow": 950,
"avg_balance": 450,
"balance_stability": 0.65,
"counterparties": 12,
"tx_frequency": 38,
"weekend_activity": 0.28,
"airtime_avg": 8,
"airtime_freq": 6,
"airtime_regularity": 0.82,
"device_type": "smartphone",
"device_age_months": 14,
"requested_amount": 300,
"requested_term_days": 90,
"loan_purpose": "business",
"region": "central_africa"
}'Endpoints
Submit an application for scoring. Returns score, tier, recommendation, and SHAP contributions.
{
"score": 742,
"tier": "A",
"default_probability": 0.02,
"decision": "APPROVED",
"recommended_limit": 5000,
"recommended_term_days": 365,
"recommended_apr": 12.0,
"shap_values": [
{ "feature": "balance_stability", "contribution": 0.18 },
{ "feature": "avg_inflow", "contribution": 0.15 }
],
"request_id": "req_abc123",
"processing_ms": 187
}Returns SHAP values and counterfactual explanations without storing the request.
Check API status. No authentication required.
Full Documentation
Authentication, error codes, rate limits, webhooks, and self-hosting guides.
Everything you need to integrate AfriScore into your loan origination system — including the Docker deployment guide for institutions with data residency requirements.
Try It
This is a client-side simulation using the same illustrative model as the Demo page — for live API access, apply for the pilot.
{ }This is a client-side simulation using the same illustrative model as the Demo page. For live API access, apply for the pilot.