Getting Started
Everything you need to make your first call to the QwikLive Lending API.
Prerequisites
- Sandbox credentials — a
client_id,client_secret, andpartneridentifier issued to your organization. - An HTTPS client capable of sending JSON request bodies.
- The path version segment — use
v1.
Base URL
All endpoints are relative to the versioned lending base path. The {version} segment is a path parameter:
Base path
https://<your-qwiklive-host>/v1/lending
Authentication
Every request carries three required headers plus an optional trace header:
| Header | Required | Description |
|---|---|---|
X-Client-Id | Required | Your QwikLive client identifier. |
X-Client-Secret | Required | Your client secret. Never log or expose this value. |
X-Partner | Required | Partner identifier issued to your organization. |
X-Correlation-Id | Optional | Client-supplied trace id, echoed back for end-to-end tracing. |
Content-Type | Conditional | application/json on requests that send a body. |
See the Authentication guide for full detail.
Your First Call — Create an Application
Create a loan application. Adjust the credentials, amounts, and applicant for your integration — sandbox values are synthetic.
cURL
curl -X POST "https://<host>/v1/lending/applications" \
-H "X-Client-Id: your-sandbox-client-id" \
-H "X-Client-Secret: $CLIENT_SECRET" \
-H "X-Partner: QWIKLIVE" \
-H "X-Correlation-Id: 7c3e1b90-2a44-4c8e-9b1a-0f5d2a6e8c10" \
-H "Content-Type: application/json" \
-d '{
"productCode": "PERSONAL_LOAN",
"requestedAmount": 15000.00,
"interestRate": 7.25,
"loanTerm": { "termCount": 36, "termUnit": "Months" },
"applicant": { "firstName": "Jane", "lastName": "Doe" }
}'Always check the response body, not just the status
A 200 confirms the request was accepted. Read the returned resource (application/loan/offer) for the authoritative state, and inspect the Problem envelope on any non-2xx.