Skip to navigation

Create A Journey

Bring the borrower’s credit application together and begin discovering offers from participating lending partners. Share the borrower and business details, and Aarthik Labs starts finding credit options through one journey.

You can begin here directly or continue with the journey ID returned by Dedupe or Eligibility. Business credit options may include Business Loans and Personal Loans suited to self-employed borrowers, with each offer clearly identifying its product type.

Use Fetch (Poll) Offers to see the options as they become available.

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

Idempotency-KeystringOptional1-255 characters

Start-attempt retry key. Use a fresh key for each new application attempt. Reuse the same key only when retrying the same Start request after a timeout or temporary failure. If omitted, the platform creates a fresh non-idempotent attempt with a server-generated internal key for compatibility; retries without a client key can create duplicate attempts.

x-correlation-idstringOptional1-128 characters

Optional caller-supplied trace identifier. When omitted, the API generates one and mirrors it as correlation_id.

Query parameters

journeyIDstringOptionalformat: "uuid"
Omit to create a journey. Supply the journeyID returned by Dedupe or Eligibility to continue the same borrower journey. Keep borrowerProviderID unchanged. An invalid, expired, unknown or unauthorized ID must not create a replacement journey.

Request

This endpoint expects an object.
personalobjectRequired
Personal Loan borrower profile fields for Hybrid journey start.
workobjectRequired
addressobjectRequired
journeyobjectRequired
businessLoanobjectRequired

Business Loan-specific first-form fields collected in addition to the common borrower, work, address, journey, and optional bureau payloads.

journeyTypeenumOptional

Optional credit product discriminator. Omit it or send BUSINESS_LOAN on the business-loan Hybrid path.

Allowed values:
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.

bureauobject or nullOptional

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

Response

Hybrid Business Loan journey accepted and offer fetch started or resumed.
request_idstringformat: "uuid"
correlation_idstring
timestampdatetime
dataobject
errorany

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
424
Failed Dependency Error
429
Too Many Requests Error
500
Internal Server Error