> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.credit.aarthiklabs.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.credit.aarthiklabs.com/_mcp/server. # Read Gold Loan Offers GET https://credit.aarthiklabs.com/api/v1/hybrid/gold-loan/borrowers/{borrowerProviderID}/journey/offers 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. Reference: https://docs.credit.aarthiklabs.com/api-reference/hybrid-experience/gold-loans/poll-hybrid-gold-loan-offers ## Authentication - `Authorization` header (bearer token, required) — Send `Authorization: Bearer ` from a trusted back-end. ## Servers - `https://credit.aarthiklabs.com` (Production, default) - `https://preprod.credit.aarthiklabs.com` (PreProduction) ## Request ### Path parameters - `borrowerProviderID` (string, required) — 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 - `journeyID` (string, optional) — 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. ### Headers - `x-correlation-id` (string, optional) — Optional caller-supplied trace identifier. When omitted, the API generates one and mirrors it as `correlation_id`. ## Response ### 200 Current Hybrid offer state. - `request_id` (string, required) - `correlation_id` (string, required) - `timestamp` (datetime, required) - `data` (HybridGoldOffersData, required) — Gold Loan Hybrid offer state. Account Aggregator is not part of the current Gold Loan Hybrid flow, so this object omits `account_aggregator`. - `error` (any, required) ## Errors ### 401 Unauthorized Error Missing or invalid platform API key. - `request_id` (string, required) - `correlation_id` (string, required) - `timestamp` (datetime, required) - `data` (any, required) - `error` (HybridError, required) ### 404 Not Found Error Borrower, journey, route, or offer was not found for the authenticated application scope. - `request_id` (string, required) - `correlation_id` (string, required) - `timestamp` (datetime, required) - `data` (any, required) - `error` (HybridError, required) ### 409 Conflict Error The current journey or offer state does not allow the requested transition. - `request_id` (string, required) - `correlation_id` (string, required) - `timestamp` (datetime, required) - `data` (any, required) - `error` (HybridError, required) ### 429 Too Many Requests Error Too many requests. For offer polling, retry at the returned `polling.nextPoll` timestamp. - `PollHybridGoldLoanOffersRequestTooManyRequestsError` - HybridErrorResponse: HybridErrorResponse - HybridOfferPollingRateLimitedResponse: HybridOfferPollingRateLimitedResponse ### 500 Internal Server Error Temporary upstream or platform failure. - `request_id` (string, required) - `correlation_id` (string, required) - `timestamp` (datetime, required) - `data` (any, required) - `error` (HybridError, required) ## Types ### HybridGoldOffersData Gold Loan Hybrid offer state. Account Aggregator is not part of the current Gold Loan Hybrid flow, so this object omits `account_aggregator`. - `status` (enum, required) - Allowed values: `STARTED`, `NOT_PROFILED`, `PROFILED`, `OFFERED`, `NOT_OFFERED`, `OFFER_ACCEPTED`, `LENDER_REDIRECTED`, `REJECTED`, `DISBURSED`, `EXPIRED` - `polling` (HybridPolling, required) - `lenders` (map from string to HybridGoldLenderOfferGroup, required) - `journeyID` (string, required) — Aarthik Labs journey ID. Matches `data.journey.id` in lifecycle web-hooks for the same borrower journey. ### HybridError - `code` (enum, required) - Allowed values: `VALIDATION_FAILED`, `AUTH_INVALID_API_KEY`, `AUTH_INVALID_SESSION`, `ACCESS_SCOPE_MISMATCH`, `RESOURCE_NOT_FOUND`, `OFFER_LOCK_CONFLICT`, `STATE_PRECONDITION_FAILED`, `OFFER_POLL_RATE_LIMITED`, `HYBRID_JOURNEY_NOT_READY`, `RATE_LIMITED`, `UPSTREAM_TEMPORARY_FAILURE` - `message` (string, required) - `retryable` (boolean, required) — Whether retrying the same operation can make progress. A persisted final primary-form failure is not retryable, including HTTP 500; reconcile the accepted operation before any resubmission. Correct invalid input before retrying validation failures. - `details` (map from string to any, required, nullable) ### HybridErrorResponse - `request_id` (string, required) - `correlation_id` (string, required) - `timestamp` (datetime, required) - `data` (any, required) - `error` (HybridError, required) ### HybridOfferPollingRateLimitedResponse - `request_id` (string, required) - `correlation_id` (string, required) - `timestamp` (datetime, required) - `data` (HybridOfferPollingRateLimitedResponseData, required) - `error` (HybridError, required) ### HybridPolling - `shouldPoll` (boolean, required) - `lastPoll` (datetime, required) - `nextPoll` (datetime, required) ### HybridGoldLenderOfferGroup - `minimumLoanAmount` (string, required, nullable) - `maximumLoanAmount` (string, required, nullable) - `offers` (list of HybridOfferRow, required) - `branches` (list of HybridGoldLocation, optional) — Gold Loan branch locations received from lender on_select responses. ### HybridOfferPollingRateLimitedResponseData - `polling` (HybridPolling, required) ### HybridOfferRow - `consentHandleAvailable` (boolean, required, nullable) - `annualPercentageRate` (string, required, nullable) - `installmentAmount` (string, required, nullable) - `ltvRatio` (string, required, nullable) - `status` (enum, required, nullable) - Allowed values: `OFFER_AWAITED`, `OFFER_RECEIVED`, `NO_OFFER_AVAILABLE` - `offerID` (string, required, nullable) — Use this in the Hosted URL endpoint only when it is non-null and the row is selectable. - `amountPrincipal` (string, required, nullable) - `interestRate` (string, required, nullable) - `offerTerm` (string, required, nullable) - `processingFee` (string, required, nullable) — Processing fee quoted by the lender for the offer, when available. - `applicationFee` (string, required, nullable) — Application fee quoted by the lender for the offer, when available. - `offerValidity` (string, required, nullable) — How long the lender offer remains valid, when available. - `ondcTransactionID` (string, required, nullable) - `offerSignals` (HybridOfferSignals, optional) - `productType` (enum, optional) — Present on Business Hybrid rows to identify the source product behind the public Business application. - Allowed values: `BUSINESS_LOAN`, `PERSONAL_LOAN` ### HybridGoldLocation - `id` (string, optional, nullable) - `gps` (string, optional, nullable) - `name` (string, optional, nullable) - `address` (string, optional, nullable) - `pincode` (string, optional, nullable) ### HybridOfferSignals - `offerType` (enum, required) — How firm the lender-side offer is at the polling stage. - Allowed values: `DEDUPE_OFFER`, `PROVISIONAL_OFFER`, `FINAL_OFFER` - `fulfillmentJourneyType` (enum, required) — Expected borrower fulfillment path after selecting the offer. - Allowed values: `FULLY_DIGITAL_STP`, `COMBINED_ONLINE_OFFLINE`, `OFFLINE_ASSISTED` - `conversionChance` (enum, required) — Business-configured conversion likelihood signal for borrower guidance. - Allowed values: `VERY_HIGH`, `HIGH`, `MODERATE`, `LOW`, `VERY_LOW` ## Examples **Response** ```json { "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 } ``` **SDK Code** ```python Gold Loan offers import requests url = "https://credit.aarthiklabs.com/api/v1/hybrid/gold-loan/borrowers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/journey/offers" querystring = {"journeyID":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"} headers = { "x-correlation-id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "Authorization": "Bearer " } response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript Gold Loan offers const url = 'https://credit.aarthiklabs.com/api/v1/hybrid/gold-loan/borrowers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/journey/offers?journeyID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'; const options = { method: 'GET', headers: { 'x-correlation-id': 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', Authorization: 'Bearer ' } }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Gold Loan offers package main import ( "fmt" "net/http" "io" ) func main() { url := "https://credit.aarthiklabs.com/api/v1/hybrid/gold-loan/borrowers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/journey/offers?journeyID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("x-correlation-id", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Gold Loan offers require 'uri' require 'net/http' url = URI("https://credit.aarthiklabs.com/api/v1/hybrid/gold-loan/borrowers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/journey/offers?journeyID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["x-correlation-id"] = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java Gold Loan offers import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://credit.aarthiklabs.com/api/v1/hybrid/gold-loan/borrowers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/journey/offers?journeyID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") .header("x-correlation-id", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") .header("Authorization", "Bearer ") .asString(); ``` ```php Gold Loan offers request('GET', 'https://credit.aarthiklabs.com/api/v1/hybrid/gold-loan/borrowers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/journey/offers?journeyID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', [ 'headers' => [ 'Authorization' => 'Bearer ', 'x-correlation-id' => 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', ], ]); echo $response->getBody(); ``` ```csharp Gold Loan offers using RestSharp; var client = new RestClient("https://credit.aarthiklabs.com/api/v1/hybrid/gold-loan/borrowers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/journey/offers?journeyID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"); var request = new RestRequest(Method.GET); request.AddHeader("x-correlation-id", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift Gold Loan offers import Foundation let headers = [ "x-correlation-id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "Authorization": "Bearer " ] let request = NSMutableURLRequest(url: NSURL(string: "https://credit.aarthiklabs.com/api/v1/hybrid/gold-loan/borrowers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/journey/offers?journeyID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```