Create Onboarding Object

endpoint /api/channels/…channel id /onboardings request type post headers content type “ application/json ” authorization “ channel access token ” input { "email" "user\@mail com", "username" "username", "phone" "76xxxxxxx3", "name" "name", "channelemail" "xyz\@email com", "redirecturl" "https //xyz com", "languagelist" \[" list of langauages "], "languageselected" " language selected ", "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 " } } property data type example values email string ( required ), valid email investor’s email username string ( required ) string of lower case alphabets, digits, ' ', ' ', ' ' with min length of 3 investor’s username phone string ( required ) 10 digit string and the first digit is one of '6,7,8,9' investor’s phone number name string ( required ) string of min length of 2 consisting of any character investor’s name channelemail string ( optional ) valid email email to get notifications at various events (currently applicable only for cams response for the investors data push to cams) redirecturl string ( optional ) valid url investor gets redirected to this url if onboarding via the signzy web platform languagelist array ( optional ) keywords that can be passed \["en", "hi", "kn", "bn", "mr"] select the keywords for the respective languages that should be shown on 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 on the merchant’s page english “en”, hindi “hi”, kannada “kn”, bengali “bn”, marathi “mr” prefilldata object ( optional ) valid json some of the data of investors can be prefilled here (for signzy frontend users only) prefilldata(for signzy frontend users only) 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's name mothername string ( optional ), string of min length of 2 consisting of any character investor’s mother's name dob string ( optional ), date of birth as a 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 of 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 and the first digit is one of '6,7,8,9' investor’s phone number placeofbirth string( optional ), string of min length of 2 consisting of any character place of brith response { "id" " onboarding id ", "createobj" { "customerid" " customerid ", "email" "user\@mail com", "id" " onboarding password ", "name" "name", "phone" "76xxxxxxx3", "username" "username" } } 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