Create A Journey | Credit Platform | Documentation

curl -X POST https://credit.aarthiklabs.com/api/v1/hybrid/personal-loan/borrowers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/journey \
     -H "Idempotency-Key: start-attempt-20260408-001" \
     -H "x-correlation-id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "personal": {
    "contactNumber": "9876543210",
    "pan": "ABCPE1234F",
    "panName": "John Doe",
    "dob": "1970-01-01",
    "gender": "male",
    "personalemail": "john_doe@foobar.com"
  },
  "address": {
    "addressL1": "101, Sunshine Heights",
    "addressL2": "Gold Coast Road",
    "city": "Rajkot",
    "state": "Gujarat",
    "pincode": "360001"
  },
  "work": {
    "employmentType": "salaried",
    "income": 75000,
    "companyName": "Acme Pvt. Ltd.",
    "officialemail": "john.doe@company.com",
    "incomeType": "monthly"
  },
  "journey": {
    "endUse": "travel",
    "bureauConsent": true
  },
  "bureau": {
    "type": "EXPERIAN",
    "data": {
      "score": 742,
      "accounts": [
        {
          "id": "account-1",
          "status": "active"
        }
      ]
    },
    "pulledAt": "2026-05-04T10:00:00.000Z",
    "reportReference": "experian-report-1",
    "consentReference": "borrower-consent-1"
  }
}'

{
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "correlation_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "timestamp": "1970-01-01T00:00:00.000Z",
  "data": {
    "profile": {
      "personal": {
        "pan": "ABCPE1234F",
        "panName": "John Doe",
        "dob": "1990-01-01",
        "gender": "male",
        "personalemail": "john_doe@foobar.com",
        "contactNumber": "+919876543210"
      },
      "workProfile": {
        "employmentType": "salaried",
        "officialemail": "john.doe@company.com",
        "income": "75000",
        "income_annualized": "900000",
        "companyName": "Acme Pvt. Ltd.",
        "udyamNumber": null
      },
      "address": {
        "addressL1": "101, Sunshine Heights",
        "addressL2": "Gold Coast Road",
        "city": "Rajkot",
        "state": "Gujarat",
        "pincode": "360001"
      },
      "bankingInformation": {
        "accHolderName": null,
        "acctype": null,
        "accNo": null,
        "ifscCode": null
      }
    },
    "journey": {
      "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "end_use": "travel",
      "bureau_consent": true
    },
    "operation": {
      "type": "OFFERS_FETCH",
      "status": "SUCCESS"
    }
  },
  "error": null
}

Backend-only API-key call. The platform starts a Hybrid personal-loan application attempt for the borrower, stores the supplied profile prefill, and starts the offer-fetch pipeline. The complete address object is required and must include non-empty addressL1, addressL2, city, state, and a six-digit pincode; invalid address data is rejected before journey creation. borrowerProviderID is client-scoped and must remain stable for the same borrower across sessions and application attempts. Prefer sending a fresh Idempotency-Key for each new Start attempt; reuse the same key only to retry the same Start request. If omitted, the platform creates a fresh non-idempotent attempt with a server-generated internal key.

Store data.journey.id from the response and pass it as journeyID on Offers and Hosted handoff calls.

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 starts a Hybrid personal-loan application attempt for the borrower, stores the supplied profile prefill, and starts the offer-fetch pipeline. The complete `address` object is required and must include non-empty `addressL1`, `addressL2`, `city`, `state`, and a six-digit `pincode`; invalid address data is rejected before journey creation. `borrowerProviderID` is client-scoped and must remain stable for the same borrower across sessions and application attempts. Prefer sending a fresh `Idempotency-Key` for each new Start attempt; reuse the same key only to retry the same Start request. If omitted, the platform creates a fresh non-idempotent attempt with a server-generated internal key. Store `data.journey.id` from the response and pass it as `journeyID` on Offers and Hosted handoff calls. 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 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.

Request

This endpoint expects an object.

personalobjectRequired

Personal Loan borrower profile fields for Hybrid journey start.

addressobjectRequired

journeyTypeenumOptional

Optional credit product discriminator. Omit it or send PERSONAL_LOAN on the personal-loan Hybrid path.

workobjectOptional

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

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. Replays of the same Start attempt return the same journey.

request_idstringformat: "uuid"

correlation_idstring

timestampdatetime

dataobject

errorany

Errors

400

Bad Request Error

401

Unauthorized Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error