Skip to main content

Overview

The EasyCred Partner API lets your backend originate consumer loan applications on EasyCred’s platform. You can either hand the customer a ready-made EasyCred screen, or drive every step yourself from your own app. This guide walks a partner engineer through a working integration in order: get credentials → sign requests → start a journey → drive it to a decision → track the outcome. Each section is self-contained — you can read it top to bottom during onboarding, or jump to a specific step.
Audience: Partner backend engineers. All examples are server-to-server (REST + JSON). No customer PII is ever returned by this API.

Base URLs

Import the OpenAPI spec into Postman or Swagger UI for an interactive explorer with all schemas.

Two Integration Modes

You choose the integration mode per request, at the moment you start a journey (the channel field). Pick the one that matches how much of the customer experience you want to own.

Hosted (API_HOSTED)

Starting a journey returns a hostedUrl. You redirect or embed it — EasyCred’s screens handle OTP, offers, KYC, e-sign and mandate. You just track the final status.Best for: The fastest integration — you don’t build any loan screens.

Headless (API_HEADLESS)

Starting a journey returns a journeySession. Your backend drives the flow over REST — reading state, submitting customer choices, and opening third-party links at verification steps.Best for: Full control — you build and own the customer-facing UI.

Quick Start Flow

1

Get Your Credentials

Receive your apiKey and signingSecret from EasyCred at onboarding. Store them immediately — they are shown only once.
2

Sign Your Requests

Every request requires an HMAC-SHA256 signature computed from your signingSecret. See Authentication.
3

Start a Loan Journey

Call POST {baseurl}/v1/partner/journey/initiate with the customer’s details and your chosen mode.
4

Drive to a Decision

For headless: poll journey state and respond to each nextAction. For hosted: hand off the hostedUrl and track status.
5

Track the Outcome

Read the terminal outcome or subscribe to webhooks for real-time status updates.