Skip to navigation

Liquify Vendor API Reference

Interactive reference documentation and contract for Liquify Partner & Vendor integration.

The Liquify Vendor API provides RESTful endpoints to facilitate loan-against-mutual-funds (LAMF) customer onboarding, identity verification, portfolio sync, and credit limit computation.

Base URLs

All requests must be directed to your assigned Liquify gateway environment:

EnvironmentBase URLDescription
UAT / Sandboxhttps://a7.liquifyfin-uat.inPartner staging and integration testing
Production(blank)Dedicated production endpoint provided upon go-live

Authentication

Every API call requires Bearer Token authentication via the VendorBearerAuth scheme. Pass your vendor token in the Authorization HTTP header:

Authorization: Bearer <vendor_token>

Each API is switched on for your organization individually. An API you do not hold returns 403 ACCESS_DENIED. Keep your token confidential. If your token is compromised, contact Liquify Partner Operations immediately for key rotation.

Request & Response Format

All API requests accepting a payload must send Content-Type: application/json.

  • Money is formatted as a decimal string (e.g. "245000.00"), never a JSON number.
  • Timestamps are ISO 8601 formatted strings.
  • Rate Limits & Failures return a Retry-After header indicating seconds to wait.

Standard Success Envelope (2xx)

Every successful response contains:

  • data: The requested entity or operation payload.
  • meta: Operational metadata including the unique request ID (request_id) and ISO 8601 timestamp (ts).
{
"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"
}
}

Standard Error Envelope (RFC 9457 Problem Details)

All 4xx and 5xx errors adhere to RFC 9457 problem details (application/problem+json). The code field is from Liquify’s stable error registry and never changes meaning:

{
"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"
}

Error Codes Reference

HTTP StatusError CodeDescription
400 Bad RequestVALIDATION_FAILEDRequest breaks schema or field constraints. Inspect errors for field details.
401 UnauthorizedAUTH_INVALID_TOKENBearer token is missing, expired, or invalid.
403 ForbiddenACCESS_DENIEDThis API endpoint is not switched on for your organization.
403 ForbiddenCONSENT_REQUIREDCustomer has not granted (or has withdrawn) a necessary consent purpose (KYC_PAN, MF_HOLDINGS, PARTNER_SHARE).
404 Not FoundNOT_FOUNDCustomer is not on your book, or an unknown verification ID was provided.
409 ConflictSTATE_CONFLICT / PORTFOLIO_NOT_SYNCEDCustomer is not in an actionable state (e.g. sync incomplete or existing active session).
422 UnprocessableKYC_REQUIREDNot an individual’s PAN (fourth char must be P), under 18, or PAN failed verification.
422 UnprocessableMF_SYNC_CONTACT_NOT_LINKEDCustomer folios are registered to a different email or mobile at the registrar.
429 Too Many RequestsMF_SYNC_RATE_LIMITEDCustomer sync cooldown reached or caller rate limits exceeded. Check Retry-After header.
503 Service UnavailablePROVIDER_UNAVAILABLE / MF_SYNC_PROVIDER_UNAVAILABLEDownstream registrar or KYC provider is unreachable. Retry after Retry-After seconds.

API Endpoints Overview

The Liquify Vendor API is organized into 3 functional domains across 10 endpoints:

Platform
  • GET /v1/ping
    Check token validity and API grant status.
Customer onboarding
  • POST /v1/pan-verifications
    Verify a PAN with KYC provider or read cached verification.
  • POST /v1/customers
    Create a customer on your partner book.
  • POST /v1/customers/{customer_id}/consents
    Relay customer consent or withdrawal with evidence.
  • GET /v1/customers/{customer_id}/consents
    Read the customer’s active consent status per purpose.
Eligibility
  • POST /v1/customers/{customer_id}/holding-syncs
    Start holdings sync with registrar (MFCENTRAL, CAMS, KFIN).
  • POST /v1/customers/{customer_id}/holding-syncs/{session_id}/verify
    Submit registrar OTP or expedite MF Central check.
  • GET /v1/customers/{customer_id}/holding-syncs/{session_id}
    Check status of asynchronous holdings sync.
  • GET /v1/customers/{customer_id}/eligibility
    Query borrowing limit by Customer ID.
  • POST /v1/eligibility/lookup
    Query borrowing limit by PAN (body payload).

Interactive API Explorer

Use the navigation in the sidebar to inspect every endpoint, view detailed request/response schemas, configure parameters, and execute live calls right from this documentation portal.