Create A Journey | Credit Platform | Documentation

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

Backend-only API-key call. The platform creates or resumes a Hybrid personal-loan journey for the borrower, stores the supplied profile prefill, and starts the offer-fetch pipeline. `borrowerProviderID` is client-scoped and must remain stable for the same mobile number across all sessions. Optionally, buyer-apps can include buyer-supplied bureau data in the top-level `bureau` object. When `bureau` is provided, `journey.bureauConsent` must be `true`.

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.

Request

This endpoint expects an object.

personalobjectRequired

journeyTypeenumOptional

Optional credit product discriminator for product-specific Hybrid journeys. Defaults to PERSONAL_LOAN when omitted.

Allowed values:

workobjectOptional

addressobjectOptional

bankingInformationobjectOptional

Optional complete bank prefill. If supplied, send the full object.

banking_informationobjectOptional

Optional complete bank prefill. This snake_case shape is accepted and normalized to the platform banking model.

journeyobjectOptional

goldLoanobjectOptional

Gold Loan-specific prefill for Hybrid Gold Loan journeys.

bureauobject or nullOptional

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

Response

Hybrid journey accepted and offer fetch started or resumed.

request_idstringformat: "uuid"

correlation_idstring

timestampdatetime

dataobject

errorany

Errors

400

Bad Request Error

401

Unauthorized Error

429

Too Many Requests Error

500

Internal Server Error

1	curl -X POST https://credit.aarthiklabs.com/api/v1/hybrid/personal-loan/borrowers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/journey \
2	-H "x-correlation-id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"personal": {
7	"contactNumber": "9876543210"
8	}
9	}'

1	{
2	"request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
3	"correlation_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
4	"timestamp": "1970-01-01T00:00:00.000Z",
5	"data": {
6	"profile": {
7	"personal": {
8	"pan": null,
9	"panName": null,
10	"dob": null,
11	"gender": null,
12	"personalemail": null,
13	"contactNumber": "+919876543210"
14	},
15	"workProfile": {
16	"employmentType": null,
17	"officialemail": null,
18	"income": null,
19	"income_annualized": null,
20	"companyName": null,
21	"udyamNumber": null
22	},
23	"address": {
24	"addressL1": null,
25	"addressL2": null,
26	"city": null,
27	"state": null,
28	"pincode": null
29	},
30	"bankingInformation": {
31	"accHolderName": null,
32	"acctype": null,
33	"accNo": null,
34	"ifscCode": null
35	}
36	},
37	"journey": {
38	"end_use": null,
39	"bureau_consent": null
40	},
41	"operation": {
42	"type": "OFFERS_FETCH",
43	"status": "SUCCESS"
44	}
45	},
46	"error": null
47	}

Authentication

Path parameters

Headers

Request

Response

Errors