v1

latestOpenAPI 3.0.32026-07-24190128.9 KB

Create unity user

A unity user is created before initiating the loan application journey. The API accepts a bunch of optional values like contact & bank details, date of birth, etc. that can be passed at the time of Unity User creation. These values will be later pre-populated in the LAMF journey for the user and improve the user experience.

post/backend/{gatewayname}/v1/user

Path parameters

gatewaynamestring required

Headers

x-gateway-secretstring required

Required | apiSecret shared for authentication

x-gateway-authtokenstring required

Required | JWT created with payload {"iss":"<your_gateway_name>"}, and signed with the shared secret

Request body

panstring required

Required | PAN of the user to be pre-filled in the LAMF or LAS journey

referrerstring

Optional | Only if part of the LAMF or LAS referrer program

dobstring

Optional | To pre-fill the date of birth in the LAMF or LAS journey (DD-MM-YYYY) format

isLienMarkingMockedboolean

Optional | If enabled then holdings will not be actually lien marked and the Unity user can be used for testing

holdingsLastFetchedAtstring date-time

Required if holdings array is passed

opaqueIdstring

Optional | To attribute your system identifier with the Unity user

productTypestring

Optional | Product type for the loan. Defaults to lamf (covers both LAMF and LAS)

assetType'MUTUALFUND' | 'STOCKS'

Optional | Asset type for the loan. MUTUALFUND for LAMF (default), STOCKS for LAS

namestring

Optional | To pre-fill user's name in the LAMF or LAS journey

agestring

Optional | Used to pre-fill the user's age in the LAMF or LAS journey. If either DOB or age is provided, the user will not be prompted to enter it during the journey.

isNriboolean

Optional | Indicates whether the user is an NRI. Required for certain lenders in the LAMF or LAS journey

Response

200

codeinteger

messagestring

Example response

{
  "data": {
    "referrer": "gatewaydemo-stag",
    "unityUserId": "658d6c3833f6a51c79d3e796"
  },
  "message": "SUCCESS"
}