Skip to main content

Overview

EASYCRED provides flexible tracking mechanisms to monitor loan progress in real-time across both Hosted (API_HOSTED) and Headless (API_HEADLESS) journeys:

Tracking ID Architecture

Understanding EASYCRED’s tracking IDs ensures seamless reconciliation:
  • journeyId (jrn_<uuid>): Returned by POST /journey/initiate for both Hosted and Headless channels. It is the primary identifier used for Journey Status polling (GET /journey/{journeyId}) and Webhook notifications (data.journeyId).
  • applicationId (24-character hex MongoDB ObjectId): Generated when the loan application is recorded in EASYCRED’s database (e.g. 6ae1b47ce5656d0175f6596a). Returned in GET /api/v1/partner/leads and queried via GET /api/v1/partner/leads/{applicationId}/status.
  • Internal Reference IDs: Internal banking rail or lender session IDs (such as 36-character UUID strings like 01a18...) are managed privately by EASYCRED’s infrastructure. API partners do not use these IDs; you always track externally using journeyId or applicationId.

1. Check Journey Status (GET /journey/{journeyId})

Check the real-time state, lender offers, and outcome of a journey using its journeyId:
Required Scope: leads:status:read
Headers: Standard HMAC headers (x-api-key, x-timestamp, x-nonce, x-signature)
(Works for both Hosted and Headless modes. No X-Journey-Session token is required).

Response Example (In-Flight / Terminal Rejection)

Response Example (Loan Sanctioned & Disbursed)

When the loan is successfully disbursed, outcome flips to "COMPLETED", currentNextAction.endpoint is null, and the response includes the lender-verified loanStatement carrying the confirmed payout, repayment terms, and signed Key Fact Statement (KFS) download link:
Proxy Endpoint Mapping: EASYCRED protects internal vendor architecture (ADR 0001). currentNextAction.endpoint always points to EASYCRED proxy routes (such as /api/v1/partner/journey/{journeyId}/action during COLLECT steps, or /api/v1/partner/journey/{journeyId}/redirect-returned during REDIRECT returns), and resolves to null during POLL and TERMINAL phases.

2. List Partner Leads & Applications

Retrieve a paginated list of all applications originated by your account. This endpoint returns real-time operational status without exposing customer PII:
Required Scope: leads:read
Headers: Standard HMAC headers (x-api-key, x-timestamp, x-nonce, x-signature)

Query Parameters

Response Example


3. Get Application Status by applicationId

Retrieve the current processing or terminal status of an individual application:
Required Scope: leads:status:read
Headers: Standard HMAC headers

Response Example (In-Flight / Rejected)

Response Example (Disbursed)

When the loan has completed disbursal, the status returns "COMPLETED" along with the confirmed net proceeds credited to the borrower:

Complete Status Reference

EASYCRED returns standardized status codes across the Leads API, Journey API, and Webhooks:

Terminal Outcomes (data.outcome / Terminal status)

When an application completes its lifecycle, it transitions into one of these terminal outcomes:

In-Flight Processing Statuses (currentNextAction.type / Active status)

While an application is actively being processed: