Fetch (Poll) Offer & Hand-Off Link | 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
}

Take the borrower from choosing an offer to continuing their application. Using the selected offer and the same journey ID, retrieve the offer details and a secure link to Aarthik Labs' Hosted Experience.

Open the link to guide the borrower through the next steps for their chosen lender, such as verification, required documents and agreements. Your experience handles discovery and selection, while the Hosted Experience helps the borrower continue the selected application.

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.

isOfferAcceptedstringOptionalDeprecated

Deprecated compatibility parameter. Its value is ignored; Aarthik Labs server configuration determines the effective offer-acceptance decision.

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