Skip to navigation

Read Gold Loan Offer And Hand-Off URL

Backend-only API-key call. Use after the borrower selects a Gold Loan offer and branch in your UI. Pass the Start response data.journey.id as journeyID so the Hosted handoff continues the intended application attempt. The branch ID must come from data.lenders.<lenderName>.branches[].id in Read Gold Loan Offers. The response returns a short-lived hosted_url plus lender details, offer details, and the lender relationship manager contact details received as fulfillment-agent details in the second on_select response. Hosted owns tracking, resume, status, and post-disbursal steps after this handoff. If journeyID is omitted, borrower-only fallback is legacy behavior and may return a 409 ambiguity error when the same borrower has multiple active Hybrid application attempts.

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.

branchIDstringRequired>=1 character

Branch identifier returned in data.lenders.<lenderName>.branches[].id by Read Gold Loan Offers.

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.

Response

Hosted URL and Gold Loan offer detail issued for the selected offer.
request_idstring
correlation_idstring
timestampdatetime
dataobject
errorany

Errors

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