API ReferenceHybrid ExperienceBusiness Loan

Read Business Loan Offers

Read-only aggregate call for the public Business root. Poll at `data.polling.nextPoll` until selectable offers, an actionable `data.account_aggregator.url` when applicable, `NOT_OFFERED`, or `data.polling.shouldPoll = false`. Every row includes `productType: BUSINESS_LOAN | PERSONAL_LOAN`; source journey IDs are never returned. Calls before `nextPoll` can return `429` with `OFFER_POLL_RATE_LIMITED`.

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.

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

Current aggregate Hybrid Business Loan offer state.
request_idstring
correlation_idstring
timestampdatetime
dataobject
Aggregate Business Hybrid offer state for both financing sources behind one public root journey.
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