> 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 Offer And Hand-Off URL GET https://credit.aarthiklabs.com/api/v1/hybrid/gold-loan/borrowers/{borrowerProviderID}/journey/offers/{offerID}/branches/{branchID}/hosted Backend-only API-key call. Use after the borrower selects a Gold Loan offer and branch in your UI. Pass the Start response `data.journey.id` as `journeyID` so the Hosted handoff continues the intended application attempt. The branch ID must come from `data.lenders..branches[].id` in Read Gold Loan Offers. The response returns a short-lived hosted\_url plus lender details, offer details, and the lender relationship manager contact details received as fulfillment-agent details in the second on\_select response. Hosted owns tracking, resume, status, and post-disbursal steps after this handoff. 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/get-hybrid-gold-loan-hosted-experience-url ## 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. - `offerID` (string, required) — Offer identifier returned in `data.lenders..offers[].offerID`. - `branchID` (string, required) — Branch identifier returned in `data.lenders..branches[].id` by Read Gold Loan Offers. ### 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 Hosted URL and Gold Loan offer detail issued for the selected offer. - `request_id` (string, required) - `correlation_id` (string, required) - `timestamp` (datetime, required) - `data` (HybridGoldHostedURLData, required) - `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. - `GetHybridGoldLoanHostedExperienceUrlRequestTooManyRequestsError` - 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 ### HybridGoldHostedURLData - `hosted_url` (string, required, nullable) — Short-lived Hosted Experience entry URL. Open immediately. - `expires_at` (datetime, required, nullable) - `target_offer_id` (string, required) - `target_branch_id` (string, required) — Gold Loan branch selected by the borrower from the offers polling response. - `target_journey_id` (string, required) - `journey` (HybridGoldHostedJourney, required) ### 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) ### HybridGoldHostedJourney - `id` (string, required) — Aarthik Labs journey ID. Matches `data.journey.id` in lifecycle web-hooks for the same borrower journey. - `type` (enum, optional) - Allowed values: `GOLD_LOAN` - `status` (enum, optional, nullable) - Allowed values: `STARTED`, `NOT_PROFILED`, `PROFILED`, `OFFERED`, `NOT_OFFERED`, `OFFER_ACCEPTED`, `LENDER_REDIRECTED`, `REJECTED`, `DISBURSED`, `EXPIRED` - `lender` (HybridHostedLender, optional) - `offer` (HybridGoldHostedOffer, optional) ### HybridOfferPollingRateLimitedResponseData - `polling` (HybridPolling, required) ### HybridHostedLender - `id` (string, optional, nullable) - `lender_name` (string, optional, nullable) - `lender_gro_name` (string, optional, nullable) - `lender_gro_email` (string, optional, nullable) - `lender_gro_contact_number` (string, optional, nullable) - `lender_gro_designation` (string, optional, nullable) - `lender_gro_address` (string, optional, nullable) - `lender_customer_support_link` (string, optional, nullable) - `lender_customer_support_contact_number` (string, optional, nullable) - `lender_customer_support_email` (string, optional, nullable) ### HybridGoldHostedOffer - `id` (string, optional, nullable) - `accepted` (boolean, optional, nullable) - `expired` (boolean, optional, nullable) - `amountPrincipal` (string, optional, nullable) - `amountTotalInterestPayable` (string, optional, nullable) - `amountNetDisbursedAmount` (string, optional, nullable) - `offerTerm` (string, optional, nullable) - `interestRate` (string, optional, nullable) - `interestType` (string, optional, nullable) - `annualPercentageRate` (string, optional, nullable) - `numberOfInstallments` (integer, optional, nullable) - `coolOffPeriod` (string, optional, nullable) - `termsAndConditionsLink` (string, optional, nullable) - `keyFactsStatementLink` (string, optional, nullable) - `applicationFees` (string, optional, nullable) - `foreclosureFees` (string, optional, nullable) - `interestRateConversionCharges` (string, optional, nullable) - `delayPenaltyFees` (string, optional, nullable) - `otherPenaltyFees` (string, optional, nullable) - `processingFees` (string, optional, nullable) - `otherUpfrontCharges` (string, optional, nullable) - `insuranceCharges` (string, optional, nullable) - `otherCharges` (string, optional, nullable) - `installments` (list of map from string to any, optional) - `relationshipManager` (HybridRelationshipManager, optional) ### HybridPolling - `shouldPoll` (boolean, required) - `lastPoll` (datetime, required) - `nextPoll` (datetime, required) ### HybridRelationshipManager - `name` (string, optional, nullable) - `phone` (string, optional, nullable) ## 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": { "hosted_url": "https://credit.aarthiklabs.com/lab/handoff?handoff=xxXxxX0x0x...#bt_test_xxx000", "expires_at": "2026-05-14T09:16:30.000Z", "target_offer_id": "offer_gl_001", "target_branch_id": "branch_001", "target_journey_id": "journey_gl_001", "journey": { "id": "journey_gl_001", "type": "GOLD_LOAN", "status": "OFFERED", "lender": { "id": "lender_001", "lender_name": "Gold Lender", "lender_gro_name": "Support Lead", "lender_gro_email": "gro@example.com", "lender_customer_support_contact_number": "1800123456" }, "offer": { "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": [ { "serialNumber": 1, "type": "INSTALLMENT", "amount": "12000.00", "status": "PAID | OVERDUE | NOT-DUE", "dueDate": "2024-08-01" }, { "serialNumber": 2, "type": "INSTALLMENT", "amount": "12000.00", "status": "PAID | OVERDUE | NOT-DUE", "dueDate": "2024-08-01" }, { "serialNumber": 3, "type": "INSTALLMENT", "amount": "12000.00", "status": "PAID | OVERDUE | NOT-DUE", "dueDate": "2024-08-01" } ], "relationshipManager": { "name": "Rajesh Sharma", "phone": "+91-9876543210" } } } }, "error": null } ``` **SDK Code** ```python Gold Loan hosted handoff import requests url = "https://credit.aarthiklabs.com/api/v1/hybrid/gold-loan/borrowers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/journey/offers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/branches/branch_001/hosted" 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 hosted handoff const url = 'https://credit.aarthiklabs.com/api/v1/hybrid/gold-loan/borrowers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/journey/offers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/branches/branch_001/hosted?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 hosted handoff 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/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/branches/branch_001/hosted?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 hosted handoff require 'uri' require 'net/http' url = URI("https://credit.aarthiklabs.com/api/v1/hybrid/gold-loan/borrowers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/journey/offers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/branches/branch_001/hosted?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 hosted handoff 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/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/branches/branch_001/hosted?journeyID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") .header("x-correlation-id", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") .header("Authorization", "Bearer ") .asString(); ``` ```php Gold Loan hosted handoff request('GET', 'https://credit.aarthiklabs.com/api/v1/hybrid/gold-loan/borrowers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/journey/offers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/branches/branch_001/hosted?journeyID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', [ 'headers' => [ 'Authorization' => 'Bearer ', 'x-correlation-id' => 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', ], ]); echo $response->getBody(); ``` ```csharp Gold Loan hosted handoff using RestSharp; var client = new RestClient("https://credit.aarthiklabs.com/api/v1/hybrid/gold-loan/borrowers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/journey/offers/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/branches/branch_001/hosted?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 hosted handoff 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/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/branches/branch_001/hosted?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() ```