Create A Gold Loan Journey | Credit Platform | Documentation

curl -X POST https://credit.aarthiklabs.com/api/v1/hybrid/gold-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": "1990-01-01",
    "gender": "male",
    "personalemail": "john@example.com",
    "userType": "individual"
  },
  "work": {
    "employmentType": "salaried",
    "income": 90000,
    "companyName": "Acme Global Inc.",
    "incomeType": "monthly"
  },
  "address": {
    "addressL1": "101 Sunshine Heights",
    "addressL2": "Gold Coast Road",
    "city": "Rajkot",
    "state": "Gujarat",
    "pincode": "360001"
  },
  "journey": {
    "endUse": "medicalTreatmentAndEmergencies",
    "consent": true
  },
  "goldInformation": {
    "jewelleryWeightGrams": "52",
    "purity": "22K"
  }
}'

{
  "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@example.com",
        "contactNumber": "+919876543210"
      },
      "workProfile": {
        "employmentType": "salaried",
        "income": "90000",
        "income_annualized": "1080000",
        "companyName": "Acme Global Inc."
      },
      "address": {
        "addressL1": "101 Sunshine Heights",
        "addressL2": "Gold Coast Road",
        "city": "Rajkot",
        "state": "Gujarat",
        "pincode": "360001"
      },
      "goldInformation": {
        "jewelleryWeightGrams": "52",
        "purity": "22K"
      }
    },
    "journey": {
      "id": "journey_gl_001",
      "end_use": "medicalTreatmentAndEmergencies",
      "consent": true
    },
    "operation": {
      "type": "OFFERS_FETCH",
      "status": "SUCCESS"
    }
  },
  "error": null
}

Backend-only API-key call. The platform starts a Hybrid Gold Loan application attempt for the borrower, stores the supplied profile and Gold Loan details, and starts the Gold Loan offer-fetch pipeline. borrowerProviderID 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. The product is implied by the /gold-loan URL. Gold Loan start does not accept bureau, banking information, or loan preferences.

Backend-only API-key call. The platform starts a Hybrid Gold Loan application attempt for the borrower, stores the supplied profile and Gold Loan details, and starts the Gold Loan offer-fetch pipeline. `borrowerProviderID` 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. The product is implied by the /gold-loan URL. Gold Loan start does not accept bureau, banking information, or loan preferences.

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

Request

This endpoint expects an object.

personalobjectRequired

Gold Loan borrower profile fields for Hybrid journey start. Include userType for Gold Loan borrower classification.

workobjectRequired

Gold Loan borrower work profile fields. Official email is not required for the Gold Loan Hybrid start payload.

addressobjectRequired

journeyobjectRequired

goldInformationobjectRequired

Gold details for Hybrid Gold Loan journeys.

journeyTypeenumOptional

Optional credit product discriminator. Omit it or send GOLD_LOAN on the gold-loan Hybrid path.

Response

Hybrid Gold Loan 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

429

Too Many Requests Error

500

Internal Server Error