Skip to navigation

Read Offer (And Hand-Off URL)

Backend-only API-key call. Use after the borrower selects an offer in your UI. Pass the Start response data.journey.id as journeyID so the handoff continues the intended application attempt. Offer acceptance is controlled by Aarthik Labs configuration scoped to the tenant, application, and lender; the configured value wins and defaults to enabled when no policy exists. The deprecated isOfferAccepted query parameter is ignored. Inspect offer_acceptance.requested for the effective server decision and offer_acceptance.applied for this call’s outcome. Open the returned short-lived Aarthik Labs URL immediately. For pending external lender steps it displays a minimal unbranded loader, waits internally, and automatically forwards the borrower when the canonical lender URL is ready; the integrator does not poll this third API. A single-redirection journey forwards to the lender destination, while a multiple-redirection journey forwards to the current external stage such as KYC. The borrower does not need to click Verify or an Aarthik Labs button. For completed or terminal stages the URL opens the Hosted offer and journey tracker for status, offer details, and servicing. Repeating the same request is safe and returns a fresh continuation URL. 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.

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

Hosted entrypoint for review, an internal loader, the current lender step, or completed-journey re-entry.

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