Overview
EASYCRED uses permission scopes to secure real-time API endpoints. Your API key is assigned scopes when created in the Partner Portal. Calls made without the required scope return403 Forbidden.
Real-Time API Scopes
Initiates real-time borrower loan journeys (both Hosted and Headless modes).Endpoint:
POST /v1/partner/journey/initiateRetrieves approved loan offers and sanctioned credit terms from lending partners.Endpoint:
GET /v1/partner/journey/:idSubmits borrower offer selections and drives downstream verification steps (KYC, mandate, e-sign).Endpoint:
POST /v1/partner/journey/:id/actionChecks real-time application status, journey stage, and disbursement progression.Endpoints:
GET /v1/partner/journey/:id and GET /v1/partner/leads/:id/statusFetches the list of enabled real-time loan products and their validation rules.Endpoint:
GET /v1/partner/productsLists historical loan applications submitted by your organization with pagination.Endpoint:
GET /v1/partner/leadsRegisters and manages webhook subscription endpoints for real-time lifecycle event callbacks.Endpoint:
POST /v1/partner/webhooksScope Errors
If an API call is made without the required scope, the server returns403 Forbidden: