Credit Risk Score API

One POST returns Smart Score Pro™ - a decision-ready score and risk grade built on first-party financial behaviour from bank statement data, bureau data, or both. Use it to drive auto-approve / auto-decline at scale.

Integration highlights - the full endpoint reference, payloads and sandbox live in the developer wiki.

Overview

The Score endpoint returns a risk score and risk grade for a consumer using bank statement data, bureau data, or both, depending on which identifiers you provide. It reflects financially productive and non-productive behaviours, without penalising consumers for shopping around or relying on blunt proxies like postcodes.

Authentication

Bank-statement requests are signed with HMAC using the credentials we issue you; bureau enquiries use OAuth2. We provide signing helpers.

// sign the request with the helper we provide const signature = signRequest(method, path, body, secret); Authorization: HMAC <TOKEN_ID>:<signature>

Quickstart

Once a customer's bank statement application has been processed, request a score by referencing it. Pass enquiry_reference_number as well to blend in bureau data. Illustrative only:

POST /api/v1/score/calculate/{vendor_label}/ { "vendor_specific_id": "123456789" } → 200 OK { "score": { "SCORE": 842, "RISK_GRADE": "8", "OVERRIDE": null }, "score_id": "6a7578d8af4e418c86807592833fab8c" }

Reading the score

  • SCORE: overall risk score, 0–1000. Higher is better.
  • RISK_GRADE: overall risk grade, 0–10. Higher is better.
  • OVERRIDE: a flag when the score needs manual review. For example: significant overdue payments (-999) or a thin file (-998).
  • score_id: a unique reference to store for report retrieval and support.

A detailed score breakdown by contributing factor is available too, and is documented in full in the wiki.

Full developer docs

The complete field reference, override codes, score-simulation tools and a working sandbox live in the TaleFin developer wiki. Access is provided to partners once we're working together.

wiki.talefin.com Request access