Credit Reporting API

Access your customer's credit profile to view current and historical credit information, from lodging an initial enquiry through to managing accounts, payments, and defaults over the life of a contract.

Integration highlights. Full endpoint reference, request/response payloads and sandbox access live in the developer wiki.

Overview

The Credit Reporting APIs is used in the complete lifecycle of a credit contract. Each stage has its own colection of endpoints.

  1. Lodge an enquiry : submit a new application for credit and retrieve a credit report.
  2. Create an account : record an approved credit contract against the enquiry.
  3. Update the account : keep account details current, and close it when the contract ends.
  4. Record payments : report ongoing payment performance against the account.
  5. Register defaults : flag and manage defaults when a customer misses payments.

New applications

When a new application is received, send the applicant's details to lodge an enquiry.

// Step 1 — lodge the enquiry POST /enquiry/lodge // Step 2 — retrieve the credit report POST /enquiry/getreport // raw data (JSON) GET /enquiry/downloadreport // formatted report (PDF)

Create accounts

Once an application is approved, create a credit account to record the liability against the bureau.

// Create a credit account for an approved application POST /account/create

Update account information

Keep the account record current throughout the life of the contract.

// Update account details, or close the account POST /account/update

Payment information

Payment performance must be reported on an ongoing basis for each active account.

// Report a payment status against an account POST /payment/save

Registering and updating defaults

When a customer has defaulted on their payments, register the default against the account and keep the details current and up to date.

// Register a new default POST /default/register // Update or close an existing default POST /default/update

Full developer docs

Complete request/response schemas, status codes, error handling 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