Credit Service API Overview

Audience

This guide is intended for technical integrators. It describes the customer journey at a high level and identifies the relevant API endpoints at each stage.

Overview

The Credit Service is a Thredd-managed integration layer that enables clients to integrate with a REST API that supports the various stages of a credit product. At a high level, the flow is:

• Retrieve available products: Fetch available Financial Products for your programme from the application metadata endpoint (GET /api/v1/credit/applications/metadata), so the applicant can select one.
• Submit an application: There are two application paths depending on your programme configuration:
  • Standard review: Start the origination process via POST /api/v1/credit/applications, triggering soft credit checks and third-party decisioning.
  • Pre-approved: Submit a pre-approved application via POST /api/v1/credit/applications/pre-approved for applicants who have already been assessed.
• Respond to an offer: For the standard review path, an offer is delivered via Thredd’s Event Delivery System (EDS) which includes an offer_id, which you must store and use to accept or decline the offer on behalf of the applicant.
• Account and card creation: On acceptance, a payment card is created automatically.
• Service the account: Use the Explorer and Accounts endpoints to manage the live account and support customer-facing functionality.

Architecture Overview

The Credit Service acts as an orchestration layer between:

• Client applications
• Thredd processing and issuing systems
• Third-party providers