API ReferenceHybrid Experience

Read Offer (And Hand-Off URL)

Backend-only API-key call. Use after the borrower selects an offer in your UI. The returned hosted_url is short-lived and should be opened immediately in the borrower browser, webview, or app shell. The endpoint is re-callable and can issue a fresh URL after the original expires.

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 mobile number and borrowerProviderID to preserve resume 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.

Response

Hosted URL 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