API ReferenceHybrid ExperienceLoan Against Mutual Funds

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. Omit `isOfferAccepted` or send exact lowercase `false` for legacy Hosted behavior. The selected lender's configured policy determines whether exact lowercase `true` is applied. `API_ALLOWED` acceptance remains supported only for online single-redirection LAMF journeys; `HOSTED_REQUIRED` returns the existing pre-acceptance pledge/offer path without applying acceptance. If the journey is already owned by Hosted Experience, the call does not replay acceptance and instead returns a fresh continuation URL for an active supported Hosted stage; a terminal journey returns `hosted_url=null` and `polling.shouldPoll=false`. Inspect `offer_acceptance.requested`, `applied`, and `mode`. Unsupported modes remain `HYBRID_HOSTED_STAGE_UNSUPPORTED`. The returned `hosted_url` is short-lived and should be opened immediately when present. 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.

isOfferAcceptedenumOptional
Optional borrower offer-acceptance request. Only the exact lowercase strings `true` and `false` are accepted. Omit it or send `false` to keep the standard Hosted flow. Send `true` only after capturing the borrower's explicit consent, then inspect `offer_acceptance.applied`. When acceptance is applied, use `polling` until a fresh `hosted_url` is available and open that URL immediately.
Allowed values:

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