User Creation
The User Creation API helps you to set up new customer profiles in your system. By using this API, you can register users by gathering their essential information along with details about their financial assets. Once a user is successfully registered, they are assigned a unique finsire_id, which is crucial for identifying them within your system and should be securely stored on your server. This helps in organizing user data effectively and complying with regulatory standards.
Input
To create a new user profile, you need to provide the following details:
User: Contains personal information about the user.
Name: The full name of the user (e.g., "John Doe").
Phone: The phone number of the user (e.g., "9876543210").
PAN Card: The PAN (Permanent Account Number) of the user (e.g., "PANQU6322Q").
Asset Details: A list describing the types of financial assets the user owns (e.g., Salary, Insurance, Gold, Bonds, FD, GST, ITR, Bank Account Statements, Vehicle, Mutual Funds, NPS).
KYC Status: Indicates whether the user has completed their KYC procedures (true or false).
Output
The output from this API is a unique identifier called a finsire_id, assigned to the user upon successful registration. This ID should be stored carefully as it's necessary for future interactions with the user.
finsire_id: The unique identifier for the user (e.g., "finsire_123456789").
Input Type
| Input | Type | Description |
|---|---|---|
| user | object | A user object consisting of name, phone, email, and PAN as mandatory fields. The optional fields are Aadhaar, dob, address and upi_id. |
| assets | array | An array containing all the assets which the user wants to view their asset data. See all the accepted values below Stocks, Salary, Insurance, Gold, Bonds, FD, GST, ITR, Bank Account Statements, Vehicle, Mutual Funds, NPS, etc. |
| kyc_done | boolean | It is a boolean value and the request will only go through if its value is passed as "True" |
Common error scenarios
The following are the common error scenarios in sending an API request:
| Error | Description |
|---|---|
| param is missing or the value is empty: user | user is a required field |
| param is missing or the value is empty: assets | assets is a required field |
| param is missing or the value is empty: kyc_done | kyc_done is a required field |
Try out the API here
Updated 3 months ago