Read Gold Loan Offers | Credit Platform | Documentation

curl -G https://credit.aarthiklabs.com/api/v1/hybrid/gold-loan/borrowers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/journey/offers \
     -H "x-correlation-id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \
     -H "Authorization: Bearer <token>" \
     -d journeyID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

{
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "correlation_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "timestamp": "1970-01-01T00:00:00.000Z",
  "data": {
    "status": "OFFERED",
    "polling": {
      "shouldPoll": true,
      "lastPoll": "1970-01-01T00:00:20.000Z",
      "nextPoll": "1970-01-01T00:00:30.000Z"
    },
    "lenders": {
      "Aurum Bank": {
        "minimumLoanAmount": "50000.00",
        "maximumLoanAmount": "5000000.00",
        "offers": [
          {
            "consentHandleAvailable": false,
            "annualPercentageRate": "5.00",
            "installmentAmount": "88460.00",
            "ltvRatio": null,
            "status": "OFFER_RECEIVED",
            "offerID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "amountPrincipal": "400000",
            "interestRate": "12.00",
            "offerTerm": "5 months",
            "processingFee": "1100.00",
            "applicationFee": "1000.00",
            "offerValidity": "15 days",
            "ondcTransactionID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "offerSignals": {
              "offerType": "FINAL_OFFER",
              "fulfillmentJourneyType": "COMBINED_ONLINE_OFFLINE",
              "conversionChance": "VERY_HIGH"
            }
          }
        ],
        "branches": [
          {
            "id": "L1",
            "gps": "28.574909, 77.194029",
            "name": "Mumbai Central",
            "address": "123 Marine Drive, Mumbai, Maharashtra",
            "pincode": "400001"
          },
          {
            "id": "L2",
            "gps": "28.584909, 77.134029",
            "name": "Mumbai East",
            "address": "162 Dadar, Mumbai, Maharashtra",
            "pincode": "400001"
          },
          {
            "id": "L3",
            "gps": "28.584909, 77.134029",
            "name": "Mumbai West",
            "address": "182 Juhu, Mumbai, Maharashtra",
            "pincode": "400001"
          }
        ]
      }
    },
    "journeyID": "journey_gl_001"
  },
  "error": null
}

Read-only API-key call. Pass the Start response data.journey.id as journeyID to poll the intended application attempt. Poll this endpoint using data.polling.nextPoll until selectable Gold Loan offers, NOT_OFFERED, or data.polling.shouldPoll = false is returned. Gold Loan polling returns lender-grouped offers and branch locations from on_select responses. Account Aggregator is not part of the current Gold Loan Hybrid flow. If journeyID is omitted, borrower-only fallback is legacy behavior and may return a 409 ambiguity error when the same borrower has multiple active Hybrid application attempts.

Read-only API-key call. Pass the Start response `data.journey.id` as `journeyID` to poll the intended application attempt. Poll this endpoint using data.polling.nextPoll until selectable Gold Loan offers, NOT_OFFERED, or data.polling.shouldPoll = false is returned. Gold Loan polling returns lender-grouped offers and branch locations from on_select responses. Account Aggregator is not part of the current Gold Loan Hybrid flow. If `journeyID` is omitted, borrower-only fallback is legacy behavior and may return a 409 ambiguity error when the same borrower has multiple active Hybrid application attempts.

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.

Query parameters

journeyIDstringOptional>=1 character

Journey ID returned as data.journey.id by Start. Send this on Offers and Hosted handoff calls to continue the intended application attempt. The journey_id query parameter is also accepted.

Response

Current Hybrid offer state.

request_idstring

correlation_idstring

timestampdatetime

dataobject

Gold Loan Hybrid offer state. Account Aggregator is not part of the current Gold Loan Hybrid flow, so this object omits account_aggregator.

errorany

Errors

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors