Read Business Loan Offers | Credit Platform | Documentation

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

{
  "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": {
      "Business 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": "journey_bl_001",
    "polling": {
      "shouldPoll": true,
      "lastPoll": "1970-01-01T00:00:20.000Z",
      "nextPoll": "1970-01-01T00:00:30.000Z"
    }
  },
  "error": null
}

Read-only API-key call. Poll this endpoint using data.polling.nextPoll until selectable Business Loan offers, an actionable data.account_aggregator.url when applicable, NOT_OFFERED, or data.polling.shouldPoll = false is returned. The response shape is aligned with the self-employed Personal Loan Hybrid offers response. Calls before nextPoll can return 429 with OFFER_POLL_RATE_LIMITED.

Read-only API-key call. Poll this endpoint using `data.polling.nextPoll` until selectable Business Loan offers, an actionable `data.account_aggregator.url` when applicable, `NOT_OFFERED`, or `data.polling.shouldPoll = false` is returned. The response shape is aligned with the self-employed Personal Loan Hybrid offers response. Calls before `nextPoll` can return `429` with `OFFER_POLL_RATE_LIMITED`.

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.

Response

Current Hybrid Business Loan 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

429

Too Many Requests Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors