Push Onboarding to KRA

introduction once the application is created the data has to be pushed on signzy's platform for further validation and operations to be performed the push onboarding json consists below objects with input variables kyc data contains personal and financial information such as gender, marital status, nominee relationship, pan number, aadhaar number, residential status, occupation details, annual income, and contact details identity proof contains details about the identity proof provided by the customer, such as type of proof, name, father's name, pan number, date of birth, and file url address proof contains details about the address proof provided by the customer, such as type of proof, name, expiry date, issue date, date of birth, address, pincode, state, district, city, and file url correspondence address proof contains details about the correspondence address proof provided by the customer, such as type of proof, name, number, address, pincode, date of birth, state, district, city, expiry date, file url, country, and whether the address is the same as a permanent address bank account contains file url for the bank account details video contains file url for the video submitted by the customer fatca data contains information related to the customer's compliance with fatca regulations, such as pep status, rpep status, residence for tax in india, and related person status it also includes details about the customer's place of birth, country of birth, and tax identification number api endpoint push onboarding preproduction https //backops investor onboarding preproduction signzy tech/kra handler/api/onboardings/push production https //backops investor onboarding signzy tech/kra handler/api/onboardings/push sample request curl location 'https //backops investor onboarding preproduction signzy tech/kra handler/api/onboardings/push' \\ \ header 'content type application/json' \\ \ header 'accept application/json' \\ \ header 'authorization \<authorization token>' \\ \ data '{ "onboardingdata" { "kycdata" { "gender" "", "emailid" "", "countrycode" "", "pannumber" "", "maidenname" "", "fathername" "", "fathertitle" "", "maidentitle" "", "mothertitle" "", "mothername" "", "mobilenumber" "", "annualincome" "", "aadhaarnumber" "", "maritalstatus" "", "kycaccountcode" "", "occupationcode" "", "occupationother" "", "residentialstatus" "", "citizenshipcountry" "", "nomineerelationship" "", "permanentaddresstype" "", "permanentaddresscode" "", "occupationdescription" "", "kycaccountdescription" "", "applicationstatuscode" "", "citizenshipcountrycode" "", "communicationaddresscode" "", "communicationaddresstype" "", "applicationstatusdescription" "", "annualincomerange" "", "placeofbirth" "" }, "identityproof" { "name" "", "fathername" "", "dateofbirth" "", "type" "", "number" "", "fileurl" \[] }, "addressproof" { "expirydate" "", "issuedate" "", "address" "", "pincode" "", "city" "", "state" "", "district" "", "country" "", "name" "", "dateofbirth" "", "type" "", "number" "", "fileurl" \[] }, "corraddressproof" { "expirydate" "", "issuedate" "", "address" "", "pincode" "", "city" "", "state" "", "district" "", "country" "", "name" "", "dateofbirth" "", "type" "", "number" "", "fileurl" \[], "sameaspermanent" "" }, "bankaccount" { "fileurl" \[] }, "video" { "fileurl" \[] }, "fatcadata" { "pep" "no", "rpep" "no", "residentfortaxotherthanindia" "yes", "placeofbirth" "", "networth" "", "countrycodeofbirth" "in", "relatedperson" "no", "fatcadeclarationdate" "28/06/2024", "fatcaadditionaldetails" \[ { "countrycodejurisdictionresidence" "india", "taxexempt" "yes", "tinexemptreason" "01", "taxidentificationnumber" "123123" } ], "relatedpersondata" { "type" "assignee", "title" "mrs ", "name" " ", "kycnumber" "", "relatedpersonidentityproof" { "type" "", "number" "", "expirydate" "11/01/2052", "fileurl" \[ "" ] } }, "address" { "pincode" "", "city" "", "district" "", "state" "", "country" "", "address" "" } }, "signature" { "signatureimageurl" "" }, "userforensics" { "userdata" { "geodata" { "city" "" } } }, "userphoto" "", "esign" { "signedpdf" "" }, "empdetails" { "name" "", "designation" "", "branch" "", "code" "" } }, "callbackurl" "" }' request field description object name key data type required/optional description header content type string required application/json authorization string required access token from login body kycdata gender string required investor’s gender values “female” / “male” / “transgender” maritalstatus string required investor’s marital status, values “married” / “unmarried” / “others” nomineerelationship string required pass either “father” or “spouse”, accordingly pass the name in “fathername” fathertitle string required pass the title of father or spouse, possible values “mr ” / “mrs ” maidentitle string required (allow empty) title for maiden name, values “mrs ” / “ms ” / “mx ” maidenname string required (allow empty) maiden name of investor provided investor is a female pannumber string required investors pan number or incase of pan exempt pass panexempt aadhaarnumber string required (allow empty) investor aadhaar number mothertitle string required investor mother title, values “mrs ” / “ms ” / “mx ” residentialstatus string required investor’s residential status, values “resident individual” / “foreign national” / “person of indian origin” occupationdescription string required (allow empty) occupation description (refer table 1 3) occupationcode string required occupation code (refer table 1 3) kycaccountcode string required kyc account code, pass 01 or 02 (refer table 1 4) kycaccountdescription string required kyc account description, new or modify with documents(refer table 1 4) communicationaddresscode string required communication address code (refer table 1 6) communicationaddresstype string required (allow empty) communication address type (refer table 1 6) permanentaddresscode string required permanent address code (refer table 1 6) permanentaddresstype string required permanent address type (refer table 1 6) citizenshipcountrycode string required citizenship country code (refer table 1 1) citizenshipcountry string required citizenship country (refer table 1 1) applicationstatuscode string required application status code, (refer table 1 5) applicationstatusdescription string required application status description, (refer table 1 5) fathername string required pass the father or spouse name mobilenumber string(required), valid 10 digit mobile number required mobile number countrycode number required country code of mobile number emailid string required email id of investor mothername string (required), string of min length of 2 consisting of any character required investor mother name annualincome string required (allow empty) annual income code (refer table 1 8) annualincomerange enum string, valid as per code in table 1 8 required (allow empty "") annual income description (refer table 1 8) placeofbirth string, string of min length of 2 consisting of any character required (allow empty) place of brith occupationother string required in case of cvl kra if occupation code is 99 string of 50 characters identityproof type enum string required “individualpan” / “aadhaar” / “passport” / “drivinglicence” / “voterid”/"pandigilocker"/"aadhaardigilocker"/dldigilocker/"aadhaarxml" name string ,string of min length of 2 consisting of any character required name on poi document fathername string optional father's name on poi document number string required pan number on poi document dateofbirth string required dob on poi document in dd/mm/yyyy or dd mm yyyy format address string required except for individual pan address as on poi document for “aadhaar” / “passport” / “drivinglicence” / “voterid”/"aadhaardigilocker"/dldigilocker/"aadhaarxml" pincode string required except for individual pan pincode as on poi document for “aadhaar” / “passport” / “drivinglicence” / “voterid”/"aadhaardigilocker"/dldigilocker/"aadhaarxml" state string required except for individual pan state as on poi document for “aadhaar” / “passport” / “drivinglicence” / “voterid”/"aadhaardigilocker"/dldigilocker/"aadhaarxml" district string required except for individual pan district as on poi document for “aadhaar” / “passport” / “drivinglicence” / “voterid”/"aadhaardigilocker"/dldigilocker/"aadhaarxml" city string required except for individual pan city as on poi document for “aadhaar” / “passport” / “drivinglicence” / “voterid”/"aadhaardigilocker"/dldigilocker/"aadhaarxml" expirydate string required except for individual pan expiry date as on poi document for “aadhaar” / “passport” / “drivinglicence” / “voterid”/"aadhaardigilocker"/dldigilocker/"aadhaarxml" issuedate string required except for individual pan issue date as on poi document for “aadhaar” / “passport” / “drivinglicence” / “voterid”/"aadhaardigilocker"/dldigilocker/"aadhaarxml" fileurl array of urls required an array of image urls of the id card, front and back in order in case of pan, pass url of front image and in case of driving license pass urls of either front or both sides of images addressproof type string required “aadhaar” / “passport” / “drivinglicence” / “voterid”/"aadhaardigilocker"/dldigilocker/"aadhaarxml" name string required name on poa document expirydate string required,allow empty expiry date on the document issuedate string required, allow empty issue date on the document dateofbirth string required dob on poa document number string required document number on poa document address string required address as on poa document pincode string required pincode as on poa document state string required state as on poa document district string required district as on poa document city string required city as on poa document fileurl array required an array of image urls of the id card, front and back in order in case of pan, pass url of front image and in case of driving license pass urls of either front or both sides of images country string required country as on poa document corraddressproof type string required “aadhaar” / “passport” / “drivinglicence” / “voterid”/"aadhaardigilocker"/dldigilocker/"aadhaarxml" name string required name on cpoa document number string required expiry date on the cpoa document address string required issue date on the cpoa document pincode string required dob on cpoa document dateofbirth string required document number on cpoa document state string required address as on cpoa document district string required pincode as on cpoa document city string required state as on cpoa document expirydate string required, allow empty district as on cpoa document issuedate string required, allow empty bankaccount fileurl array optional city as on poa document video fileurl string optional an array of image urls of the id card, front and back in order in case of pan, pass url of front image and in case of driving license pass urls of either front or both sides of images fatcadata sameaspermanent string if cpoa same as poa pep string required politically exposed person "yes" / "no" rpep string required related to a politically exposed person "yes" / "no" residentfortaxotherthanindia string required whether resident for tax outside india "yes" / "no" placeofbirth string required but can be empty place of birth fatcadata networth numeric value conditionally required required if residentfortaxotherthanindia is 'yes' need to enter the kra code for networth relatedperson string required whether there is a related person "yes" / "no" fatcadeclarationdate string required fatca declaration date fatcaadditionaldetails dd/mm/yyyy fatcaadditionaldetails countrycodejurisdictionresidence string required but can be empty country of jurisdiction of residence fatcaadditionaldetails taxexempt string required but can be empty whether tax exempt "yes" / "no" fatcaadditionaldetails tinexemptreason string required but can be empty if tax exempt is yes only then required refere the kra sheet for code fatcaadditionaldetails taxidentificationnumber string required but can be empty tax identification number, to be provided given “residentfortaxinindia” is “yes” also if tax exempt is no is required relatedpersondata relatedpersondata type string optional type of related person "assignee", "guardian of minor", etc relatedpersondata title string optional title of related person "mr ", "mrs ", etc relatedpersondata name string optional name of related person relatedpersondata kycnumber string optional kyc number of related person relatedpersonidentityproof string optional object containing related person's identity proof details relatedpersonidentityproof type string optional type of related person’s id proof "drivinglicence", etc relatedpersonidentityproof number string optional id proof number of related person relatedpersonidentityproof expirydate string optional expiry date of the id proof relatedpersonidentityproof fileurl string optional array of file urls (front and back of the id) fatcadata address pincode string optional fatca address pincode, to be provided given “residentfortaxinindia” is “yes” city string optional fatca address city, to be provided given “residentfortaxinindia” is “yes” district string optional fatca address district, to be provided given “residentfortaxinindia” is “yes” state string optional fatca address state code (refer table 1 2), to be provided given “residentfortaxinindia” is “yes” country string optional fatca address country (refer table 1 1), to be provided given “residentfortaxinindia” is “yes" address string optional fatca address, to be provided given “residentfortaxinindia” is “yes” signature signatureimageurl string required signature image url userforensics userdata geodata city string required geo location city of user userphoto userphoto string required user photo url esign signedpdf string required signed form url combined of all the data and documents empdetails name string required but can be empty eipv details name of employee designation string required but can be empty eipv details designation of employee branch string required but can be empty eipv details brand of employee code string required but can be empty eipv details employee code callbackurl callbackurl string optional callback url to receive the response on kra push sample responses 200 { "customerid" "63xxxxxxx61", "requestid" "64xxxxxxxxx05f", "callbackurl" "https //eoji86rqlkxh0zx m pipedream net" } 400 sample 1 when poi is pan { "error" { "statuscode" 400, "name" "validationerror", "message" "\\"onboardingdata identityproof number\\" is not allowed to be empty", "details" \[ { "message" "\\"onboardingdata identityproof number\\" is not allowed to be empty", "path" \[ "onboardingdata", "identityproof", "number" ], "type" "string empty", "context" { "label" "onboardingdata identityproof number", "value" "", "key" "number" } } ] } } sample 2 when poi is aadhaar and aadhaar number is invalid { "error" { "statuscode" 400, "name" "validationerror", "message" "\\"onboardingdata identityproof number\\" with value \\"0000\\" fails to match the 8 zeros followed by 4 digits pattern", "details" \[ { "message" "\\"onboardingdata identityproof number\\" with value \\"0000\\" fails to match the 8 zeros followed by 4 digits pattern", "path" \[ "onboardingdata", "identityproof", "number" ], "type" "string pattern name", "context" { "name" "8 zeros followed by 4 digits", "regex" {}, "value" "0000", "label" "onboardingdata identityproof number", "key" "number" } } ] } } sample 3 when mobile is passed as "999" { "error" { "statuscode" 400, "name" "validationerror", "message" "please enter a valid 10 digit mobile number ", "details" \[ { "message" "please enter a valid 10 digit mobile number ", "path" \[ "onboardingdata", "kycdata", "mobilenumber" ], "type" "string pattern name", "context" { "name" "mobile number", "regex" {}, "value" "999", "label" "onboardingdata kycdata mobilenumber", "key" "mobilenumber" } } ] } } 401 { "error" { "statuscode" 401, "name" "error", "message" "authorization required", "code" "authorization required" } } 404 while using invalid endpoint { "error" { "statuscode" 404, "name" "error", "message" "there is no method to handle get /6451198320bf270e75ce7618/onboardings/6464ad5eb4f191002445b509" } } 405 using incorrect request method type 405 not allowed &#x9; &#x9; 405 not allowed &#x9; 502 502 bad gateway 502 bad gateway response field description key data type description customerid string the id of the customer for onboarding requsetid string the application id for the onboarding journey callbackurl string the url where the complete data of the customer will be posted once the onboarding process is completed 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