Developer documentation
Credit profiles and inquiries
Query explainable score and risk data with the correct purpose, inquiry type and interpretation.
Querying a profile
GET /credit/{subject_id} records an inquiry automatically. Send purpose and inquiry_type explicitly so the audit record reflects the real use.
| Inquiry type | Use |
|---|---|
| SOFT | Account review or informational assessment |
| HARD | A new credit application or material underwriting decision |
| MONITORING | Permitted ongoing portfolio monitoring |
| MANUAL_REPORT | Human-requested detailed review |
Reading the response
- credit.score is 300–850 when rated and null when history is insufficient.
- credit.grade is a band such as A or an NR marker; always render status and grade alongside score.
- credit.confidence describes depth and quality of the available history, not probability of repayment.
- risk contains calculated risk indicators; history summarises reported accounts and events.
- reason_codes explain material drivers. Preserve and display them wherever a score informs a workflow.
- model_version and calculated_at identify the exact output used.
Score history
GET /credit/{subject_id}/history returns score snapshots newest first. limit accepts 1–200 and defaults to 50. Use history to explain movement, not to infer unreported wealth or character.
Underwriting policy
Required independent checks
A high score does not establish identity, affordability, collateral value, legal capacity or the appropriateness of a product. Define policy for NR results, thin files, stale reports, disputes and manual overrides.