Read Business Loan Offer And Hand-Off URL | Credit Platform | Documentation

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

{
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "correlation_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "timestamp": "1970-01-01T00:00:00.000Z",
  "data": {
    "hosted_url": "https://credit.aarthiklabs.com/lab/handoff?handoff=xxXxxX0x0x...#bt_test_xxx000",
    "expires_at": "1970-01-01T00:15:00.000Z",
    "target_offer_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "target_journey_id": "journey_bl_001",
    "journey": {
      "type": "BUSINESS_LOAN",
      "offer": {
        "productType": "BUSINESS_LOAN",
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "accepted": false,
        "expired": false,
        "amountPrincipal": "400000",
        "amountTotalInterestPayable": "42300",
        "amountNetDisbursedAmount": "392000",
        "offerTerm": "5 months",
        "interestRate": "12.00",
        "interestType": "FIXED",
        "annualPercentageRate": "5.00",
        "numberOfInstallments": 5,
        "coolOffPeriod": "3 days",
        "termsAndConditionsLink": "https://example.com/tnc.pdf",
        "keyFactsStatementLink": "https://example.com/kfs.pdf",
        "applicationFees": "0",
        "foreclosureFees": "0",
        "interestRateConversionCharges": "0",
        "delayPenaltyFees": "0",
        "otherPenaltyFees": "0",
        "processingFees": "8000",
        "otherUpfrontCharges": "0",
        "insuranceCharges": "0",
        "otherCharges": "0",
        "installments": []
      },
      "id": "journey_bl_001",
      "endUse": "businessExpansion",
      "bureauConsent": true,
      "ondc_transaction_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "status": "OFFERED",
      "kyc_status": "PENDING",
      "kyc_attempts": 0,
      "emandate_status": "PENDING",
      "emandate_attempts": 0,
      "esign_status": "PENDING",
      "esign_attempts": 0,
      "lender": {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "lender_name": "Business Bank",
        "lender_gro_name": "ONDC",
        "lender_gro_email": "lifeline@ondc.com",
        "lender_gro_contact_number": "1860 266 7766",
        "lender_gro_designation": "Nodal Grievance Redressal Officer",
        "lender_gro_address": "One Indiabulls Centre, Mumbai",
        "lender_customer_support_link": "https://buy.ondc.org/buy/GrievanceRedStep.htm?execution=e1s1",
        "lender_customer_support_contact_number": "1800 1080",
        "lender_customer_support_email": "customer.care@ondc.com"
      }
    }
  },
  "error": null
}

Backend-only API-key call. Use after the borrower selects either a BUSINESS_LOAN or self-employed PERSONAL_LOAN offer returned by the Business path. Pass the public root as journeyID; the platform resolves the actual source lender internally while preserving the public root in target_journey_id and journey.id. Omit isOfferAccepted or send exact lowercase false for legacy behavior. Send exact lowercase true after explicit borrower acceptance. A true request skips the Hosted loan-amount-adjustment step for this call even when the actual source lender normally allows adjustment. The actual source lender’s configured policy determines whether acceptance is applied: API_ALLOWED returns pollable stage metadata, while HOSTED_REQUIRED returns the Aarthik Hosted offer/KFS review URL without claiming or accepting the source. If the source journey is already owned by Hosted Experience, the call does not replay acceptance and instead returns a fresh continuation URL for an active Hosted stage; a terminal source returns hosted_url=null and polling.shouldPoll=false. Inspect offer_acceptance.requested, applied, and mode.

Backend-only API-key call. Use after the borrower selects either a BUSINESS_LOAN or self-employed PERSONAL_LOAN offer returned by the Business path. Pass the public root as `journeyID`; the platform resolves the actual source lender internally while preserving the public root in `target_journey_id` and `journey.id`. Omit `isOfferAccepted` or send exact lowercase `false` for legacy behavior. Send exact lowercase `true` after explicit borrower acceptance. A true request skips the Hosted loan-amount-adjustment step for this call even when the actual source lender normally allows adjustment. The actual source lender's configured policy determines whether acceptance is applied: `API_ALLOWED` returns pollable stage metadata, while `HOSTED_REQUIRED` returns the Aarthik Hosted offer/KFS review URL without claiming or accepting the source. If the source journey is already owned by Hosted Experience, the call does not replay acceptance and instead returns a fresh continuation URL for an active Hosted stage; a terminal source returns `hosted_url=null` and `polling.shouldPoll=false`. Inspect `offer_acceptance.requested`, `applied`, and `mode`.

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.

offerIDstringRequired>=1 character

Offer identifier returned in data.lenders.<lenderName>.offers[].offerID.

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 and x-aarthiklabs-journey-id header aliases are also accepted. If more than one alias is sent, all values must match.

isOfferAcceptedenumOptional

Optional borrower offer-acceptance request. Only the exact lowercase strings true and false are accepted. Omit it or send false to keep the standard Hosted flow. Send true only after capturing the borrower’s explicit consent, then inspect offer_acceptance.applied. When acceptance is applied, use polling until a fresh hosted_url is available and open that URL immediately.

Optional borrower offer-acceptance request. Only the exact lowercase strings `true` and `false` are accepted. Omit it or send `false` to keep the standard Hosted flow. Send `true` only after capturing the borrower's explicit consent, then inspect `offer_acceptance.applied`. When acceptance is applied, use `polling` until a fresh `hosted_url` is available and open that URL immediately.

Allowed values:

Response

Hosted URL issued for the selected Business Loan offer.

request_idstring

correlation_idstring

timestampdatetime

dataobject

errorany

Errors

400

Bad Request Error

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