Skip to navigation

Read Loan Against Mutual Funds Offer And Hand-Off URL

Backend-only API-key call. Use after the borrower selects a Loan Against Mutual Funds Credit Line or Term Loan offer in your UI. The selected lender’s server configuration controls acceptance; the deprecated isOfferAccepted value is ignored. Server-enabled acceptance remains supported only for online single-redirection LAMF journeys, while a disabled policy returns the pre-acceptance pledge/offer path. Inspect offer_acceptance.requested, applied, and mode. Supported pending and terminal states return a fresh Hosted continuation URL instead of requiring API polling. Unsupported modes remain HYBRID_HOSTED_STAGE_UNSUPPORTED. LAMF handoff responses do not expose minimumLoanAmount or maximumLoanAmount.

Authentication

AuthorizationBearer

Send Authorization: Bearer <PLATFORM_API_KEY> from a trusted back-end.

Path parameters

borrowerProviderIDstringRequired1-128 characters

Stable borrower identity from the partner system. Keep a 1:1 mapping between the borrower and borrowerProviderID across sessions and application attempts to preserve resume, history, and post-disbursal continuity.

offerIDstringRequired>=1 character

Offer identifier returned in data.lenders.<lenderName>.offers[].offerID.

Headers

x-correlation-idstringOptional1-128 characters

Optional caller-supplied trace identifier. When omitted, the API generates one and mirrors it as correlation_id.

Query parameters

journeyIDstringOptional>=1 character

Journey ID returned as data.journey.id by Start. Send this on Offers and Hosted handoff calls to continue the intended application attempt. The journey_id query parameter and x-aarthiklabs-journey-id header aliases are also accepted. If more than one alias is sent, all values must match.

isOfferAcceptedstringOptionalDeprecated

Deprecated compatibility parameter. Its value is ignored; Aarthik Labs server configuration determines the effective offer-acceptance decision.

Response

Legacy LAMF Hosted entrypoint, or supported opt-in single-redirection acceptance state.

request_idstring
correlation_idstring
timestampdatetime
dataobject
errorany

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error