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 docid\ eh9zz1kpurwnfb nnniud section sending requests for sending requests the hostname and protocol will be the same as given in the authentication docid\ eh9zz1kpurwnfb nnniud section send a post request to /api/customers/\ customer id/merchants with data as below headers property value content type application/json authorization authorisation header as per the login request request body { "name" " name ", "email" " email ", "username" " username ", "phone" " phone ", "redirecturl" " redirecturl ", "timeoutredirecturl" " session timeout url ", "languagelist" " list of langauages ", "languageselected" " language selected ", "staticdata" { "application type" "new/modify" }, "prefilldata" { "name" " name ", "fathername" " father name ", "mothername" " mother name ", "dob" " dob ", "pannumber" " pan number", "dlnumber" " dl number ", "dlissuedate" " dl issuedate ", "dlexpirydate" " dl expiry date ", "passportnumber" " passport number ", "passportissuedate" " passport issue date ", "passportexpirydate" " passport expiry date ", "aadhaaruid" " 12 digit uid ", "voteridnumber" " voterid number ", "otheridnumber" " otherid number", "otheridissuedate" " otherid issue date ", "otheridexpirydate" " otherid expiry date ", "pincode" " pincode ", "state" " state ", "district" " district ", "city" " city ", "address" " address ", "corrpincode" " corr pincode ", "corrstate" " corr state ", "corrdistrict" " corr district ", "corrcity" " corr city ", "corraddress" " corr address ", "bankaccountnumber" " bank account number ", "bankifsc" " bank ifsc ", "bankaccountholdername" " bank account holder name ", "bankaddress" " bank address ", "gender" " gender ", "maritalstatus" " martial status ", "fatherspousetitle" " father or spouse title ", "fatherspousename" " father or spouse name ", "nomineerelationship" " nominee relationship ", "maidentitle" " maiden title ", "maidenname" " maiden name ", "mothertitle" " mother title ", "emailid" " emailid ", "mobilenumber" " mobile number ", "placeofbirth" " place of birth " } } 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 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 expected create investor response { "email" " email ", "phone" " phone ", "username" " username ", "id" " id ", "customerid" " customerid ", "applicationurl" " applicationurl ", "autologinurl" " autologinurl ", "mobileloginurl" " mobileloginurl ", "mobileautologinurl" " mobileautologinurl " } the below table describes the properties that are returned in the request property accepted values/format description email 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 help\@signzy com