Read (Poll) Offers | Credit Platform | Documentation

curl -G https://credit.aarthiklabs.com/api/v1/hybrid/personal-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",
    "lenders": {
      "AA Bank": {
        "minimumLoanAmount": "50000.00",
        "maximumLoanAmount": "5000000.00",
        "offers": [
          {
            "consentHandleAvailable": true,
            "annualPercentageRate": null,
            "installmentAmount": null,
            "ltvRatio": null,
            "status": "OFFER_AWAITED",
            "offerID": null,
            "amountPrincipal": null,
            "interestRate": null,
            "offerTerm": null,
            "processingFee": null,
            "applicationFee": null,
            "offerValidity": null,
            "ondcTransactionID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
          }
        ]
      },
      "ONDC 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": "PROVISIONAL_OFFER",
              "fulfillmentJourneyType": "COMBINED_ONLINE_OFFLINE",
              "conversionChance": "HIGH"
            }
          }
        ]
      }
    },
    "journeyID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "polling": {
      "shouldPoll": true,
      "lastPoll": "1970-01-01T00:00:20.000Z",
      "nextPoll": "1970-01-01T00:00:30.000Z"
    },
    "account_aggregator": {
      "url": "https://credit.aarthiklabs.com/lab/account-aggregator?token=xxXxxX0x0x...",
      "expires_at": "1970-01-01T00:15:00.000Z",
      "lenders": [
        "AA Bank"
      ]
    }
  },
  "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 OFFER_RECEIVED offers, an actionable data.account_aggregator.url, NOT_OFFERED, or data.polling.shouldPoll = false is returned. Calls before nextPoll can return 429 with OFFER_POLL_RATE_LIMITED. 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 `OFFER_RECEIVED` offers, an actionable `data.account_aggregator.url`, `NOT_OFFERED`, or `data.polling.shouldPoll = false` is returned. Calls before `nextPoll` can return `429` with `OFFER_POLL_RATE_LIMITED`. 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

Current Hybrid offer state. Personal Loan and Business Loan use the Personal Loan-style lender-grouped offer shape. Gold Loan responses do not include Account Aggregator in Hybrid right now and can include lender branch locations. Loan Against Mutual Funds uses its own offer schema because lender groups do not expose minimum or maximum loan amounts.

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