Create Investor
The API is used for creating investors for customers that need to be onboarded. For that, we need to have a hostname and protocol which are as defined in the Authentication section.
For sending requests the hostname and protocol will be the same as given in the Authentication section.
Send a post request to: /api/customers/:customer-id/merchants with data as below.
Property | Value |
|---|---|
Content-type | application/json |
Authorization | Authorisation header as per the login request |
The below table describes all the properties available in the request body:
Property | Accepted Values/Format | Description |
|---|---|---|
name | String | Name for the end user whose onboarding needs to be conducted |
Email (String) | Email for the end user whose onboarding needs to be conducted | |
username | String | Username of the end user (needs to be provided for them to be able to login) (Username should be Lower Case and allowable characters alphanumeric and special characters (._ .)) |
phone | String 10 digit string and first digit is one of '6,7,8,9' | Phone for the end user whose onboarding needs to be conducted |
redirectUrl(optional) | String | Merchant will redirect to the redirectURL after the onboarding gets completed or if he/she clicks on the logout button. |
timeoutRedirectUrl | String (Optional) | Merchant will redirect to the timeoutRedirectUrl after the session timeout. |
languageList | Array (Optional) Keywords that can be passed - ["en", "hi", "kn", "bn", "mr"] | Select the keywords for the respective languages that should be shown in the Merchant's page. English - "en", Hindi - "hi", Kannada - "kn", Bengali - "bn", Marathi - "mr" |
languageSelected | String (Optional) Any one of these ('en', 'hi', 'kn', 'bn', 'mr') | This field ensures the default language that will appear in the Merchant's page. English - "en", Hindi - "hi", Kannada - "kn", Bengali - "bn", Marathi - "mr" |
staticData | Object(Optional) Valid JSON | To facilitate the Modification of existing KYC, this field allows to pass the Application Type as one of the following options: new , modify. |
prefillData | Object (Optional) valid JSON | Some of the data of investor can be prefilled here |
staticData object details:
Property | Data Type | Example Values |
|---|---|---|
Application Type | String (Required if staticData is passed) | new : It signifies that the KYC records are not currently available. modify : It indicates that the KYC records already exist and require modification. |
prefillData Object details for Prefilling data:
Property | Data Type | Example Values |
|---|---|---|
name | String (Optional) , string of min length of 2 consisting of any character | Investor's name |
fatherName | String (Optional) ,string of min length of 2 consisting of any character | Investor's father name |
motherName | String (Optional) ,string of min length of 2 consisting of any character | Investor's mother name |
dob | String (Optional) ,date of birth as string in DD/MM/YYYY or DD-MM-YYYY format | Investor's dob |
panNumber | String (Optional) ,Valid pan number | Pan number |
dlNumber | String (Optional) ,Valid dl number | dl number |
dlIssueDate | String (Optional) ,Issue Date as string in DD/MM/YYYY or DD-MM-YYYY format, should be a past Date | Dl issue date |
dlExpiryDate | String (Optional) ,Expiry Date as string DD/MM/YYYY or DD-MM-YYYY format, should be a future Date | Dl expiry date |
passportNumber | String (Optional) ,Valid passport number | Passport number |
passportIssueDate | String (Optional) ,Issue Date as string in DD/MM/YYYY or DD-MM-YYYY format, should be a past Date | Passport issue date |
passportExpiryDate | String (Optional) ,Expiry Date as string DD/MM/YYYY or DD-MM-YYYY format, should be a future Date | Passport expiry date |
aadhaarUid | String (Optional) ,string of 8 zeros followed by 4 digits | Aadhaar number |
voterIdNumber | String (Optional) | VoterId number |
otherIdNumber | String (Optional) | Other document number |
otherIdIssueDate | String (Optional) ,Issue Date as string in DD/MM/YYYY or DD-MM-YYYY format, should be a past Date | Other document issue date |
otherIdExpiryDate | String (Optional) ,Expiry Date as string DD/MM/YYYY or DD-MM-YYYY format, should be a future Date | Other document expiry date |
pincode | String (Optional), valid Pincode | Pincode |
state | Enum String (Optional) | State, Refer 1st column of Table 1.7 |
district | String (Optional) | District |
city | Enum String (Optional) | City |
address | String (Optional) | Address |
corrPincode | String (Optional), valid Pincode | Correspondence POA pincode |
corrState | Enum String (Optional) | Correspondence POA state, Refer 1st column of Table 1.7 |
corrDistrict | String (Optional) | Correspondence POA District |
corrCity | Enum String (Optional) | Correspondence POA city |
corrAddress | String (Optional) | Correspondence POA address |
bankAccountNumber | String (Optional), string of min length of 9 and max length 18 consisting of any digit | Account number on canceled cheque document |
bankIFSC | String (Optional), alphanumeric string of length 11 | IFSC code |
banckAccountHolderName | String (Optional),string of min length of 2 consisting of any character | Bank account holder's name |
bankAddress | String (Optional) | Bank address |
gender | Enum String (Optional) | investor's Gender values: "F" / "M" / "T" for Female, Male, Transgender |
maritalStatus | Enum String (Optional) | investor's marital status, values: "MARRIED" / "UNMARRIED" / "OTHERS" |
fatherSpouseTitle | Enum String (Optional) | Pass the title of Father or Spouse, possible values “Mr.” / “Mrs.” |
fatherSpouseName | String (Optional), string of min length of 2 consisting of any character | Pass the Father or Spouse's name |
nomineeRelationShip | Enum String (Optional) | Pass either "FATHER" or "SPOUSE", accordingly pass the name in "fatherName" |
maidenTitle | Enum String (Optional) | title for maiden name, values: "Mrs." / "Ms." / "Mx." |
maidenName | String (Optional), string of min length of 2 consisting of any character | maiden name of the investor provided investor is a Female |
motherTitle | Enum String (Optional) | Investor mother Title, values: "Mrs." / "Ms." / "Mx." |
emailId | String (Optional), valid email | Investor's Email |
mobileNumber | String (Optional) 10-digit string | Investor's Phone Number |
placeOfBirth | String(Optional), string of min length of 2 consisting of any character | Place of Brith |
The below table describes the properties that are returned in the request:
Property | Accepted Values/Format | Description |
|---|---|---|
String | Email for the end user whose onboarding needs to be conducted | |
phone | String | Phone for the end user whose onboarding needs to be conducted |
username | String | Username used to create that particular investor |
id | String | merchantId(Id for the investor) defined for this particular onboarding corresponding to the above username |
customerId | String | customerId is the client ID whose login was used to create the investor |
applicationUrl | String | URL where to redirect the user for onboarding |
autoLoginUrL | String | URL where to redirect the user for onboarding without logging in |
mobileLoginUrl | String | URL where to redirect the user for onboarding on mobile |
mobileAutoLoginUrl | String | URL where to redirect the user for onboarding on mobile without investorlogin |
Login Url and Mobile Login URL are used to redirect investors to the login page where they will give username and password for getting logged in to either desktop or mobile.
The "Auto Login Url" opens an iFrame within your application for the user to onboard without leaving your app.
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].