FAQ

Do We Need To Build The Loan Journey UI?

No. Your team builds the entry point and the container around the journey. Aarthik Labs hosts the borrower journey UI after the embedURL opens.

Does The Borrower Leave Our App?

Not necessarily. Most web integrations render the Hosted Experience in an iframe inside the customer’s app. Mobile teams may use a webview or app shell. Browser-tab flows are also possible when that is the preferred product experience.

Why Is The API Key Backend-only?

The API key identifies your tenant and application scope. It can create Hosted Experience URLs for borrowers, so it must never be exposed to browsers, mobile apps, or third-party scripts.

What Should The Frontend Receive?

The front-end should receive only:

1
{
2
  "embedURL": "https://credit.aarthiklabs.com/lab/embed?...#bt_live_xxx"
3
}

Do not expose the platform API key or internal platform session material to the front-end.

How Do We Resume A Borrower Later?

Call your back-end again with the same borrowerProviderID. Your back-end creates a fresh embedURL, and the Hosted Experience resolves the borrower scope from that stable identity.

Can We Customize The Button Or Entry Point?

Yes. Your product fully controls the button, card, banner, product tile, or any other UI that starts the journey. Hosted Experience begins after your back-end creates the embedURL and your front-end opens it.

Can We Send Only A Contact Number?

For minimal pre-fill, send borrowerProviderID, journeyType, and profile.contactNumber. This is enough for the basic Hosted Experience startup pattern.

For Gold Loan, profile.contactNumber is required.

Should We Send Extended Pre-fill?

Send extended pre-fill when you already have reliable borrower data and permission to share it. Extended pre-fill can reduce repeated data entry inside the Hosted Experience.

If you are unsure about a field’s accuracy, omit it and let the borrower provide it inside the journey.

Which Employment Type Values Should We Use?

Use:

• salaried
• selfEmployed

What Happens If Product Availability Changes?

Read product availability from GET /api/lab/features before showing product-specific entry points. If a product is disabled, hide it or show your own unavailable state.

Can We Reuse The Same Embed URL?

No. Treat embedURL as a short-lived entry point. Create a fresh URL whenever the borrower starts or resumes a journey.