Onboarding APIs

Create Onboarding Object

5min

Endpoint
/api/channels/…channel ID ../onboardings
Request Type
POST
Headers
Content-type: “application/json” Authorization: “channel access token”
Input
JSON
{
    "email":"[email protected]",
    "username":"username",
    "phone":"76xxxxxxx3",
    "name":"name",
    "channelEmail": "[email protected]",
    "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..."
}
}
{
    "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
JSON
{   
    "id": "... Onboarding Id ...",
    "createObj": {
        "customerId": "..customerId..",
        "email": "[email protected]",
        "id": ".. onboarding password ..",
        "name": "name",
        "phone": "76xxxxxxx3",
        "username": "username"
    }
}
{   
    "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 [email protected].
﻿

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)

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

Verify Captcha

Investor Login