> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.liquifyfin.in/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.liquifyfin.in/_mcp/server.

# Welcome to Liquify

Explore API Reference

Consent Guide (v1)

Integration Workflow

## Platform Overview

The **Liquify Vendor API** provides high-throughput, bank-grade infrastructure for financial institutions, wealth managers, neo-banks, and fintech partners. It allows you to seamlessly verify customer identities, orchestrate registrar-based mutual fund portfolio synchronization (MF Central, CAMS & KFintech), and calculate instant borrowing limits.

#### [Platform](/api-reference)

Live gateway reachability check and Bearer authentication token validation (`GET /v1/ping`).

#### [Customer onboarding](/api-reference)

Verify customer PANs (`POST /v1/pan-verifications`), create partner customers (`POST /v1/customers`), and capture regulatory consents (`POST / GET /v1/customers/{customer_id}/consents`).

#### [Eligibility](/api-reference)

Orchestrate mutual fund sync (`POST /v1/customers/{customer_id}/holding-syncs`), verify OTP, and read real-time borrowing limits by Customer ID or direct PAN lookup.

---

## Integration Workflow

A typical partner integration follows a 5-step sequence to onboard a customer and determine their borrowing eligibility:

```
[Partner App] ──── 1. Check Token & Grant (GET /v1/ping) ───────────> [Liquify Gateway]
      │
      ├─────── 2. Verify PAN (POST /v1/pan-verifications)
      │
      ├─────── 3. Create Customer & Relay Consent (POST /v1/customers & /consents)
      │
      ├─────── 4. Sync Holdings & Submit OTP (POST /v1/customers/{customer_id}/holding-syncs)
      │
      └─────── 5. Read Eligibility (GET /v1/customers/{customer_id}/eligibility) ───> Instant Credit Limit!
```

### 1. Authenticate with Bearer Token

All vendor requests must include your issued Bearer token in the `Authorization` header:

```bash
Authorization: Bearer <vendor_token>
```

### 2. Verify Connectivity

Before initiating customer transactions, test token validity and gateway grants using `/v1/ping`:

```bash
curl -X GET "https://a7.liquifyfin-uat.in/v1/ping" \
  -H "Authorization: Bearer <vendor_token>"
```

### 3. Customer Onboarding & Consent

Verify the customer's PAN via `POST /v1/pan-verifications` (or attest verification), then register the customer with `POST /v1/customers`. Display the mandatory [`LIQ-PARTNER-CONSENT-v1`](/partner-consent) screen before relaying consents to `POST /v1/customers/{customer_id}/consents`:

* `KYC_PAN`: Authorization to verify PAN and create the Liquify account.
* `MF_HOLDINGS`: Authorization to fetch registrar mutual fund holding statements.
* `PARTNER_SHARE`: Consent to share computed eligibility limits with the partner.

Partners can also query the customer's active consent status at any time via `GET /v1/customers/{customer_id}/consents`.

### 4. Mutual Fund Portfolio Synchronization

Trigger the synchronization process via `POST /v1/customers/{customer_id}/holding-syncs` across `MFCENTRAL`, `CAMS`, or `KFIN`.

* For `MFCENTRAL`, redirect the customer to `redirect_url` where they enter MF Central's OTP.
* For `CAMS` and `KFIN`, submit the OTP received by the customer via `POST /v1/customers/{customer_id}/holding-syncs/{session_id}/verify`.
* Poll `GET /v1/customers/{customer_id}/holding-syncs/{session_id}` until status is `COMPLETED`.

### 5. Read Borrowing Eligibility

Once portfolio synchronization completes, retrieve borrowing eligibility:

* By Customer ID: `GET /v1/customers/{customer_id}/eligibility`
* Or by Customer PAN: `POST /v1/eligibility/lookup` (PAN passed in request body)

Response includes:

* Available borrowing limit (`eligible_amount` in rupees decimal string)
* Aggregate portfolio valuation (`portfolio_value`)
* Synchronization freshness timestamp and `stale` flag

---

## Partner Consent & DPDP Compliance

Regulatory compliance is built into the core integration lifecycle. Partners must present customers with the standardized **`LIQ-PARTNER-CONSENT-v1`** agreement on a dedicated screen prior to portfolio synchronization.

#### [Consent Specification (v1)](/partner-consent)

View the full consent text, UI compliance rules, bracketed field variables, and purpose code mapping.

#### [Relay Consents API](/api-reference)

Learn how to transmit customer-granted consent purposes to `POST /v1/customers/{customer_id}/consents`.

---

## Standard Envelope Architecture

Every Liquify Vendor API response adheres to a predictable JSON envelope format:

### Success Response (2xx)

```json
{
  "data": {
    "customer_id": "cust_9830ed6a8ad3",
    "eligible_amount": "245000.00",
    "portfolio_value": "612500.40",
    "portfolio_synced_at": "2026-10-05T10:20:27Z",
    "stale": false
  },
  "meta": {
    "request_id": "38461348-c5e4-449c-b9cc-d6b08c06d11b",
    "ts": "2026-10-05T10:23:48Z"
  }
}
```

### Error Response — RFC 9457 Problem Details (`application/problem+json`)

Errors use RFC 9457 standard problem details with a stable machine-readable `code` member:

```json
{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "Customer has not granted MF_HOLDINGS consent required for portfolio synchronization",
  "code": "CONSENT_REQUIRED",
  "errors": [],
  "request_id": "8b3b64dc-1123-4212-bf9a-3214819d4bca",
  "trace_id": "trace_796f5cdf"
}
```

---

## API Reference Documentation

Dive into full endpoint documentation with request/response schemas, parameters, code samples in multiple programming languages, and an in-browser API console:

View Full API Reference