Create a Unity user before starting a loan application. One Unity user can hold both an LAMF (mutual fund) and an LAS (stocks) application — the same API is used for both, with different payloads.

📘

Store the unityUserId

The response returns a unityUserId. Store it — you'll need it for Create Interaction and Update DLA Holdings, and it's the identifier you pass to Combined Credit Snapshot.

Authentication is the same as every other Unity backend API — see the Unity API authentication for the x-gateway-secret / x-gateway-authtoken headers.

Idempotency and repeated calls

Calling this API multiple times for the same user (same PAN or same auth contact) is safe:

• Existing user by PAN — returns the existing Unity user, lender, and referrer without creating a duplicate.
• Existing user by auth contact — returns an error if the phone is already linked to a different Unity user.
• Same-payload retries — no side effect — returns the existing user Id.

So you can call this whenever you need a Unity user ID (e.g. before starting the flow) without worrying about duplicates.

LAMF (Loan Against Mutual Funds)

Use this when the user will pledge mutual fund holdings.

Example request (LAMF):

{
  "pan": "AIXOL9094G",
  "authContact": { "number": "9876543210", "countryCode": "+91" },
  "productType": "lamf",
  "assetType": "MUTUALFUND",
  "dob": "04-11-1999",
  "name": "Vishal Pal",
  "age": 35,
  "isNri": false,
  "opaqueId": "partner-ref-12345", // optional - your own identifier for this user, echoed back in webhooks and Get unity user details
  "holdings": [ // pass all values as received from the user's CAS via RTAs/MFC
    {
      "repository": "CAMS",
      "amcCode": "PP",
      "folio": "16615967",
      "schemeCode": "001ZG",
      "schemeName": "Parag Parikh Flexi Cap Fund",
      "isin": "INF879O01027",
      "schemeType": "EQUITY",
      "units": 131.57,
      "lockInUnits": 13.157,
      "isDemat": false,
      "dpId": "1208160062733129", // mandatory if isDemat is true
      "modeOfHolding": "", // optional - defaults to single holding if not passed
      "lienEligibleUnits": 120.33, // optional - if not passed, eligible units = units - lockInUnits. If passed, these are considered the eligible units for the loan
      "contact": {
        "phone": { "number": "9876543210", "countryCode": "+91" }, // required
        "email": "[email protected]"
      }
    }
  ],
  "holdingsLastFetchedAt": "2023-05-07T00:00:00Z"
}

MF holdings are optional at creation — you can seed them here via holdings[] (with holdingsLastFetchedAt), let them be fetched during the journey, or push them later via Update DLA Holdings.

LAS (Loan Against Stocks)

Use this when the user will pledge stock holdings.

Example request (LAS):

{
  "pan": "EAWPK9000N",
  "authContact": { "number": "9919921000", "countryCode": "+91" },
  "assetType": "STOCKS",
  "stockHoldings": [
    {
      "name": "TATA STEEL LIMITED",
      "isin": "INE081A01020",
      "type": "EQUITY",
      "units": 100,
      "isDemat": true,
      "dpId": "1208160010814163"
    }
  ],
  "productType": "lamf",
  "opaqueId": "partner-ref-12345", // optional - your own identifier for this user, echoed back in webhooks and Get unity user details
  "contacts": [
    { "type": "PHONE", "phone": { "number": "9919921000", "countryCode": "+91" } },
    { "type": "EMAIL", "email": "[email protected]" }
  ],
  "name": "Vishal Pal",
  "age": 55,
  "isNri": false
}

For STOCKS, every holding needs a dpId, and isDemat is always true.

Passing your own identifier

opaqueId is an optional free-form string you can attach to a Unity user to map it back to a user in your own system. It's supported in both the LAMF and LAS payloads.

• It's stored only when this call creates a new Unity user. If the call resolves to an existing user (see Idempotency and repeated calls), the opaqueId you pass is ignored and the value stored at creation is kept.
• Once set, it's echoed back on every webhook payload and in Get unity user details.
• If it was never set, those payloads carry "opaqueId": "".

This is a separate field from config.opaqueId in Create interaction, which tags a single interaction rather than the user.

Success response (HTTP 200)

{
  "code": 0,
  "data": {
    "lender": "sib",
    "referrer": "gatewaydemo-stag",
    "unityUserId": "69a960a8fd4c213259f9a609"
  },
  "message": "SUCCESS"
}

data.unityUserId is the identifier to store and reuse across the rest of the integration.

Error responses

All errors follow the same shape:

{
  "message": "<error_message>",
  "code": "<error_code>",
  "data": "<optional_data>"
}

Exact message and code values are defined by the Unity API contract; the table above summarises the main scenarios partners may see.

📘

Disabled Lien Marking (mock users) is not available for SIB

The Disabled Lien Marking (DLM) testing mode — where isLienMarkingMocked: true creates a mock user that skips real lien marking — is not available for SIB. isLienMarkingMocked stays false regardless of what you pass.