DocumentationHosted Experience

Request & Prefill Model

Hosted Experience lets you start with very little borrower data and add deeper pre-fill later. The core rule is simple: send a stable borrower identity, choose the journey type, and send only data that your app is allowed to share.

Session Request Shape

Create a Hosted Experience URL with:

POST /api/lab/sessions
Authorization: Bearer PLATFORM_API_KEY
Content-Type: application/json

Top-level request keys:

FieldRequiredPurpose
borrowerProviderIDYesStable borrower identity from your system.
journeyTypeRecommendedCredit journey to open. Use PERSONAL_LOAN or GOLD_LOAN.
profileUsuallyBorrower personal details and contact number.
workProfileNoEmployment or income pre-fill.
addressNoAddress pre-fill.
journeyNoProduct-level journey preferences such as end-use or bureau consent.
goldLoanFor Gold Loan pre-fillGold Loan-specific fields such as jewellery weight, purity, and requested amount.

The response shown to your front-end should contain only:

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

Borrower Identity

borrowerProviderID is your permanent borrower reference for the Aarthik Labs platform.

Keep a stable one-to-one mapping between the borrower in your system and borrowerProviderID. If you send a different ID for the same borrower later, the platform may treat the borrower as a new borrower, which can break resume continuity and application tracking.

Recommended examples:

  • customer ID from your system
  • user ID from your system
  • a stable borrower reference generated by your back-end

Avoid examples:

  • session ID
  • random UUID generated on every click
  • device ID
  • temporary lead ID that changes later

Minimal vs Extended Pre-fill

Minimal pre-fill gets the borrower into the journey quickly. Extended pre-fill can reduce repeated data entry and improve completion.

Use minimal pre-fill when:

  • you only know the borrower identity and contact number
  • you want the borrower to provide most information inside the Hosted Experience
  • you are still validating the product placement in your app

Use extended pre-fill when:

  • you already have verified borrower profile details
  • the borrower has consented to share those details
  • you want to reduce form entry inside the Hosted Experience

Personal Loan Examples

Personal Loan (minimal pre-fill)

1{
2  "borrowerProviderID": "BORROWER-123",
3  "journeyType": "PERSONAL_LOAN",
4  "profile": {
5    "contactNumber": "9876543210"
6  }
7}

Response:

1{
2  "embedURL": "https://credit.aarthiklabs.com/lab/embed?tenant_id=tenant_123&application_id=app_123&borrower_provider_id=BORROWER-123&journey_type=PERSONAL_LOAN#bt_live_personal_minimal"
3}

Personal Loan (salaried) (extended pre-fill)

1{
2  "borrowerProviderID": "BORROWER-SAL-123",
3  "journeyType": "PERSONAL_LOAN",
4  "profile": {
5    "contactNumber": "9876543210",
6    "pan": "ABCDE1234F",
7    "panName": "Rahul Sharma",
8    "dob": "1995-06-20",
9    "gender": "male",
10    "personalemail": "rahul@example.com"
11  },
12  "workProfile": {
13    "employmentType": "salaried",
14    "officialemail": "rahul@company.com",
15    "income": "75000",
16    "incomeType": "monthly",
17    "companyName": "Acme Pvt Ltd"
18  },
19  "address": {
20    "addressL1": "Flat 301, Sunrise Heights",
21    "addressL2": "MG Road",
22    "city": "Bengaluru",
23    "state": "Karnataka",
24    "pincode": "560001"
25  },
26  "journey": {
27    "endUse": "travel",
28    "bureauConsent": true
29  }
30}

Response:

1{
2  "embedURL": "https://credit.aarthiklabs.com/lab/embed?tenant_id=tenant_123&application_id=app_123&borrower_provider_id=BORROWER-SAL-123&journey_type=PERSONAL_LOAN#bt_live_personal_salaried"
3}

Personal Loan (self-employed) (extended pre-fill)

1{
2  "borrowerProviderID": "BORROWER-SE-123",
3  "journeyType": "PERSONAL_LOAN",
4  "profile": {
5    "contactNumber": "9876543211",
6    "pan": "BCDEF2345G",
7    "panName": "Priya Mehta",
8    "dob": "1992-04-15",
9    "gender": "female",
10    "personalemail": "priya@example.com"
11  },
12  "workProfile": {
13    "employmentType": "selfEmployed",
14    "income": "80000",
15    "incomeType": "monthly",
16    "companyName": "Mehta Traders",
17    "udyamNumber": "UDYAM-DL-10-1234567"
18  },
19  "address": {
20    "addressL1": "Shop 12, Market Plaza",
21    "addressL2": "Ring Road",
22    "city": "Delhi",
23    "state": "Delhi",
24    "pincode": "110001"
25  },
26  "journey": {
27    "endUse": "businessExpansion",
28    "bureauConsent": true
29  }
30}

Response:

1{
2  "embedURL": "https://credit.aarthiklabs.com/lab/embed?tenant_id=tenant_123&application_id=app_123&borrower_provider_id=BORROWER-SE-123&journey_type=PERSONAL_LOAN#bt_live_personal_self_employed"
3}

Gold Loan Examples

Gold Loan (minimal pre-fill)

1{
2  "borrowerProviderID": "BORROWER-GOLD-123",
3  "journeyType": "GOLD_LOAN",
4  "profile": {
5    "contactNumber": "9876543212"
6  }
7}

Response:

1{
2  "embedURL": "https://credit.aarthiklabs.com/lab/embed?tenant_id=tenant_123&application_id=app_123&borrower_provider_id=BORROWER-GOLD-123&journey_type=GOLD_LOAN#bt_live_gold_minimal"
3}

Gold Loan (extended pre-fill)

1{
2  "borrowerProviderID": "BORROWER-GOLD-456",
3  "journeyType": "GOLD_LOAN",
4  "profile": {
5    "contactNumber": "9876543213",
6    "pan": "CDEFG3456H",
7    "panName": "Amit Verma",
8    "dob": "1990-11-08",
9    "gender": "male",
10    "personalemail": "amit@example.com"
11  },
12  "workProfile": {
13    "employmentType": "salaried",
14    "officialemail": "amit@company.com",
15    "income": "90000",
16    "incomeType": "monthly",
17    "companyName": "Verma Services Pvt Ltd"
18  },
19  "address": {
20    "addressL1": "House 44, Lake View Road",
21    "addressL2": "Andheri East",
22    "city": "Mumbai",
23    "state": "Maharashtra",
24    "pincode": "400069"
25  },
26  "goldLoan": {
27    "userType": "individual",
28    "jewelleryWeightGrams": "52",
29    "purity": "22K",
30    "endUse": "medicalTreatmentAndEmergencies",
31    "bureauConsent": true,
32    "aaID": "9876543213@finvu",
33    "requestedAmount": "400000",
34    "requestedTenureMonths": 5
35  }
36}

Response:

1{
2  "embedURL": "https://credit.aarthiklabs.com/lab/embed?tenant_id=tenant_123&application_id=app_123&borrower_provider_id=BORROWER-GOLD-456&journey_type=GOLD_LOAN#bt_live_gold_extended"
3}

Field Reference

Profile

FieldNotes
profile.contactNumberIndian mobile number. Required for Gold Loan and recommended for all integrations.
profile.panPAN in uppercase format, for example ABCDE1234F.
profile.panNameName associated with PAN.
profile.dobDate of birth. Recommended format: YYYY-MM-DD.
profile.genderUse male, female, or transgender.
profile.personalemailPersonal email address.

Work Profile

FieldNotes
workProfile.employmentTypeUse salaried or selfEmployed.
workProfile.officialemailWork email address.
workProfile.incomeMonthly or annual income value.
workProfile.incomeTypeUse monthly or annual.
workProfile.companyNameEmployer or business name.
workProfile.udyamNumberUdyam number for self-employed borrowers when available.

Address

FieldNotes
address.addressL1Address line 1.
address.addressL2Address line 2.
address.cityCity.
address.stateState.
address.pincodeSix-digit PIN code.

Gold Loan

FieldNotes
goldLoan.userTypeUse individual or non-individual.
goldLoan.constitutionConstitution value for non-individual borrowers, when applicable.
goldLoan.jewelleryWeightGramsGold jewellery weight in grams.
goldLoan.purityUse 24K, 22K, 21K, 18K, 14K, or 9K.
goldLoan.endUseUse a supported product-specific end-use value.
goldLoan.bureauConsentSend true only when the borrower has provided consent.
goldLoan.aaIDAccount Aggregator handle, when available.
goldLoan.requestedAmountRequested loan amount.
goldLoan.requestedTenureMonthsRequested tenure in months.

Supported Gold Loan end-use values:

  • marriage
  • familyFunctions
  • medicalTreatmentAndEmergencies
  • travelEducationExpenses
  • businessExpansion
  • agricultureAndFarmRelatedNeeds
  • purchaseOfEquipment
  • other