Skip to navigation
API ReferenceHosted Experience

Create Embeddable URL

Backend-only API-key call. This initializes or resumes the borrower scope, creates a browser bootstrap token, and returns an embeddable URL that can be opened in an iframe, webview, browser tab, or mobile app shell. The bootstrap token is embedded in the URL fragment and expires after 120 seconds.

Optionally, buyer-apps can include buyer-supplied bureau data in the top-level bureau object. When bureau is provided, journey.creditReportConsent must be true.

Authentication

AuthorizationBearer

Send Authorization: Bearer <PLATFORM_API_KEY> from a trusted back-end.

Request

This endpoint expects an object.
borrowerProviderIDstringRequired>=1 character
Stable borrower identity from the partner system.
journeyTypeenumOptionalDefaults to PERSONAL_LOAN
Allowed values:
profileobjectOptional
workProfileobjectOptional
addressobjectOptional
journeyobjectOptional
goldLoanobjectOptional
bureauobject or nullOptional

Optional buyer-supplied bureau data. When this object is provided, journey.creditReportConsent must be true.

Response headers

Cache-ControlstringOptional

The route returns non-cacheable session material.

Response

Hosted Experience URL.
embedURLstringformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

embedUrlstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

embedurlstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

EmbedurlstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

EmbedUrlstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

EmbedURLstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

EMBEDurlstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

EMBEDUrlstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

EMBEDURLstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

embed_urlstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

embed_UrlstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

embed_URLstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

Embed_urlstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

Embed_UrlstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

Embed_URLstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

EMBED_urlstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

EMBED_UrlstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

EMBED_URLstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

embed-urlstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

embed-UrlstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

embed-URLstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

Embed-urlstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

Embed-UrlstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

Embed-URLstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

EMBED-urlstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

EMBED-UrlstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

EMBED-URLstringOptionalformat: "uri"

Canonical Hosted Experience URL. The fragment contains a short-lived bt_* bootstrap token and should be opened immediately.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error