Add a User

post

https://stage1.tab.kitecash.in/open-api/falcon/v1/user

Use this endpoint to add a new user.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

↑

Body Params

address

object

enterpriseId

string

The unique enterprise ID of the user.

aggregatorName

string

required

The name of the aggregator.

programId

string

required

The unique program ID of the user.

userFirstName

string

required

The first name of the user.

userMiddleName

string

required

The middle name of the user.

userLastName

string

required

The last name of the user.

userPAN

string

required

The PAN number of the user.

countryCode

integer

required

The country code of the user.

userMobileNumber

string

required

The mobile number of the user.

userDOB

string

The date of birth of the user.

userGender

string

enum

The user gender.

Allowed:

fatherName

string

The name of the user's father.

motherName

string

The name of the user's mother.

userOVDType

string

enum

The type of OVD (Officially Valid Document).

Allowed:

userOVDID

string

The ID of the OVD.

salutation

string

enum

The salutation of the user.

Allowed:

profession

string

The profession of the user.

spouseName

string

The name of the user's spouse.

totalLengthOfService

integer

The total length of service of the user.

lengthOfService

string

The length of service of the user.

income

integer

The income of the user.

dependents

integer

The number of dependents of the user.

netWorth

integer

The net worth of the user.

immovableAssetWorth

integer

The worth of immovable assets of the user.

movableAssetWorth

integer

The worth of movable assets of the user.

payslip

string

The payslip of the user.

incomeTaxReturn

string

The income tax return of the user.

nationality

string

The nationality of the user.

kycStatus

string

enum

The KYC status of the user.

Allowed:

profilePicture

string

The profile picture of the user.

status

string

enum

The status of the user.

Allowed:

applicationId

string

The application ID of the user.

userConsent

boolean

enum

The consent of the user.

Allowed:

Headers

x-tenant-id

string

required

Authorization

string

required

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200ok