Investor Onboarding
Investor Results Fetch by ID
6 min
after successful onboarding, we can fetch the details of a particular investor using by id which is created by a particular customer keep a time gap of 2 3 minutes before pulling the investor's data sending requests for sending requests the hostname and protocol will be the same as given in authentication docid\ eh9zz1kpurwnfb nnniud section send a post request to /api/pullmerchants with the data below headers property value content type application/json authorization authorization header as per the login request request body { "customerid" " customerid ", "merchantid" " merchantid ", "extrafields" \[" cams "] } the below table describes all the properties available in the request body property accepted values/format description customerid string customerid of that customer merchantid string merchantid of the investor extrafields array(optional) extrafields required to be appended in response (possible values 'cams') expected response { "customerid" " customerid ", "limitlength" " limitlength ", "skiplength" " skiplength ", "status" " status ", "id" 1, "result" \[ { " id" " id ", "email" " email ", "phone" " phone ", "name" " name ", "username" " username ", "customerid" " customerid ", "merchantid" " merchantid ", "status" " status ", "reason" "your application has been rejected due to undermentioned reasons ", "rejectionclassification" \[ " rejectionclassification " ], "addresstype" "permanent/correspondence/related person address which will be have value when particular id card is a address proof", "verificationdata" { "idcards" \[{ "type" " type ", "purpose" \[ "poi/poa" ], "addresstype" " addresstype ", "name" " name ", "idno" " idno ", "dob" " dob ", "address" "", "state" "", "issuedate" "", "images" \[ " images " ], "verificationstatus" { "verified" true / false, "message" " message ", "isset" 1 }, "faceextraction" { "cropped" " cropped " } }], "documents" \[ { "type" "cheque", "beneficiarymobile" " beneficiarymobile ", "beneficiaryaccount" " beneficiaryaccount ", "beneficiaryname" " beneficiaryname ", "beneficiaryifsc" " beneficiaryifsc ", "bankname" " bankname ", "branchname" " branchname ", "images" " images " }, { "type" " type ", "beneficiarymobile" " beneficiarymobile ", "beneficiaryaccount" " beneficiaryaccount ", "beneficiaryname" " beneficiaryname ", "beneficiaryifsc" " beneficiaryifsc ", "bankname" " bankname ", "branchname" " branchname ", "images" \[], "banktransferoutput" { "active" "no/yes", "namematch" "no/yes", "mobilematch" "no/yes", "signzyreferenceid" " signzyreferenceid ", "audittrail" { "nature" " nature ", "value" " value ", "timestamp" " timestamp " } }, "verifyamountoutput" { "amountmatch" "true/false", "owername" " owername ", "mobile" " mobile ", "mmid" " mmid " } } ], "video" { "url" " url ", "matchimage" " matchimage ", "signzyverifiablestring" " signzyverifiablestring ", "videomatch" { "matchaudioscore" " matchaudioscore ", }, "matchimageela" { "task" " task ", "essentials" { "url" " url " }, "id" " id ", "patronid" " patronid ", "result" " result ", }, "forensics" { "staticrisk" { "staticphoto" false / true, "agegroup" " agegroup ", }, "videolandmarks" { "result" " result ", }, "videofacematch" { "videoimages" \[" videoimages "], "finalmatchimage" " finalmatchimage ", "matchstatistics" { "covariance" " covariance ", "matchpercentage" " matchpercentage " }, }, "exif" { "message" " message ", "metadatafound" "true", "image" { "make" " make ", "model" " model ", "xresolution" "", "yresolution" "", "resolutionunit" "", "software" "", "modifydate" "{ modifydate }", "ycbcrpositioning" "", "exifoffset" " exifoffset ", "gpsinfo" "" }, "gps" { "gpsaltituderef" "", "gpslatituderef" "", "gpslatitude" \[], "gpslongituderef" "", "gpslongitude" \[], "gpsaltitude" "", "gpstimestamp" \[], "gpsprocessingmethod" "", "gpsdatestamp" "" }, "isset" 1 } }, "facelandmarks" { "result" " result ", "isset" 1 } }, "contract" { "signedcontract" " signedcontract uploaded pdf directurl " }, "fatca" { "pep" "no/yes", "rpep" "no/yes", "residentfortaxinindia" "no/yes", "relatedperson" "no/yes" }, "signature" { "signatureimageurl" " signatureimageurl " }, "formdata" { "gender" "male/female", "maritalstatus" "unmarried/married", "nomineerelationship" "father/spouse", "nomineetitle" " nomineetitle ", "maidentitle" "ms /mrs ", "maidenname" " maidenname ", "pannumber" " pannumber ", "aadhaarnumber" " aadhaarnumber ", "mothertitle" "mrs /ms ", "kycaccountcode" " kycaccountcode ", "kycaccountdescription" " kycaccountdescription ", "occupationdescription" " occupationdescription ", "occupationcode" " occupationcode ", "communicationaddresscode" " communicationaddresscode ", "communicationaddresstype" " communicationaddresstype ", "nomineename" " nomineename ", "mothername" " mothername ", "countrycode" " countrycode ", "mobilenumber" " mobilenumber ", "emailid" " emailid ", "pincode" " pincode ", "communicationaddress" " communicationaddress ", "residentialstatus" " residentialstatus ", "citizenshipcountrycode" " citizenshipcountrycode ", "citizenshipcountry" " citizenshipcountry ", "annualincome" " refer table 1 1", "placeofbirth" " " }, "info" { "name" " name ", "dob" " dob ", "emailid" " emailid ", "phone" " phone ", "communicationaddress" " communicationaddress ", "permanentaddress" " permanentaddress " } }, "formfilleddata" { "identityproof" { "type" " type ", "purpose" \[ " purpose " ], "name" " name ", "idno" " idno ", "dob" " dob ", "expirydate" "", "verify" "true/false", "address" "", "state" "", "issuedate" "", "images" \[ " images " ], "prooftype" " prooftype " }, "addressproof" \[ { "purpose" \[ " purpose " ], "name" " name ", "idno" " idno ", "dob" " dob ", "verify" "true/false", "address" " address ", "expirydate" "", "state" "", "issuedate" "", "addresstype" " addresstype ", "prooftype" " prooftype ", "images" \[ " images ", ], "pincode" " pincode ", "type" " type " }, { "purpose" \[ " purpose " ], "name" " name ", "idno" " idno ", "dob" " dob ", "verify" "false/true", "address" " address ", "expirydate" " expirydate ", "issuedate" " issuedate ", "addresstype" " addresstype ", "prooftype" " prooftype ", "images" \[ " images " ], "pincode" " pincode ", "type" " type " } ], "bankaccount" { "type" " type ", "bankname" " bankname ", "branchname" " branchname ", "images" \[ " images " ] }, "formfields" { "gender" " gender ", "maritalstatus" " maritalstatus ", "nomineerelationship" " nomineerelationship ", "maidentitle" " maidentitle ", "maidenname" " maidenname ", "pannumber" " pannumber ", "aadhaarnumber" " aadhaarnumber ", "mothertitle" " mothertitle ", "residentialstatus" " residentialstatus ", "occupationdescription" " occupationdescription ", "occupationcode" " occupationcode ", "kycaccountcode" " kycaccountcode ", "kycaccountdescription" " kycaccountdescription ", "communicationaddresscode" " communicationaddresscode ", "communicationaddresstype" " communicationaddresstype ", "citizenshipcountrycode" " citizenshipcountrycode ", "citizenshipcountry" " citizenshipcountry ", "applicationstatuscode" " applicationstatuscode ", "applicationstatusdescription" " applicationstatusdescription ", "mobilenumber" " mobilenumber ", "countrycode" " countrycode ", "emailid" " emailid ", "mothername" " mothername ", "permanentaddresscode" " permanentaddresscode ", "permanentaddresstype" " permanentaddresstype ", "nomineetitle" " nomineetitle ", "nomineename" " nomineename ", "annualincome" " refer table 1 1", "placeofbirth" " " }, "fatca" { "pep" "no/yes", "rpep" "no/yes", "residentfortaxinindia" "no/yes", "relatedperson" "no/yes", "addresstype" " addresstype ", "countrycodejurisdictionresidence" " countrycodejurisdictionresidence ", "countryjurisdictionresidence" " countryjurisdictionresidence ", "taxidentificationnumber" " taxidentificationnumber ", "placeofbirth" " placeofbirth ", "countrycodeofbirth" " countrycodeofbirth ", "countryofbirth" " countryofbirth ", "addresscity" " addresscity ", "addressdistrict" " addressdistrict ", "addressstatecode" " addressstatecode ", "addressstate" " addressstate ", "addresscountrycode" " addresscountrycode ", "addresscountry" " addresscountry ", "addresspincode" " addresspincode ", "address" " address ", "relatedpersontype" " relatedpersontype ", "relatedpersonkycnumber" " relatedpersonkycnumber ", "relatedpersonkycnumberexists" " relatedpersonkycnumberexists ", "relatedpersonidentityproof" { "name" " name ", "fathername" " fathername ", "dob" " dob ", "number" " number " }, "relatedpersontitle" " relatedpersontitle " }, "signature" { "signatureimageurl" " signatureimageurl ", "consent" "true/false" }, "photo" { "photourl" " photourl " }, "video" { "url" " url ", "matchimage" " matchimage ", "signzyverifiablestring" " signzyverifiablestring ", "seconds" \[ " seconds " ] }, "contract" { "signedcontract" " signedcontract " } }, "verificationresult" { "idcards" \[{ "status" " status ", "type" " type ", "purpose" " purpose ", "number" " number " }, { "status" "safe/ risky/ uncertain", "type" " type ", "purpose" " purpose ", "number" " number " } ], "overalstatus" "safe/ risky/ uncertain", "bankaccount" "safe/ risky/ uncertain", "amlstatus" "safe/ risky/ uncertain" } } ], "merchantcamsjson" {" investors data parsed in cams json "} } the below table describes the properties that are returned in the request parameters accepted values/format description merchantid string investor onboarding corresponding merchant id customerid string investor onboarding corresponding customer id email string email id of the merchant taken during the sign up phone string phone number of the merchant taken during the sign up name string name of the merchant taken during the sign up reason string reason due to which the application got rejected rejectionclassification string criteria, due to which the application got rejected addresstype string this will have value when a particular id card is an address proof(permanent/correspondence/related person address) username string username of the merchant taken during the sign up status string status of application (pending/accepted/rejected/draft) idcard <> object data from various id card (pan, dl, voterid, aadhaar, passport) addresstype string address type on the id card (correspondence address/permanent address) type string type of id card (pan, dl, voterid, aadhaar, passport) images string url of the image present in id card idno string idno present in the id card name string name present in the id card dob string dob present in the id card address string address present in the id card state string state name present on the id card issuedate string issue date present in the id card purpose string purpose present in the id card verificationstatus <> object verificationstatus in the id card (verified/message) faceextraction <> object face extracted from id card documents <> object data from various documents(cheques) type string type of document for bank account verification(cheque) beneficiarymobile string mobile number of beneficiary account holder beneficiaryaccount string account number of beneficiary account holder beneficiaryname string name of beneficiary account holder beneficiaryifsc string ifsc number of beneficiary account bankname string bank name of the beneficiary account branchname string branch name of the beneficiary account banktransferoutput <> object result of money transfer to the bank account active string whether the bank account is active or not(yes/no) namematch string whether the name in the document matches or not(yes/no) mobilematch string whether the mobile number in the document matches or not(yes/no) signzyreferenceid string signzy reference id for bank account verification audittrail <> object audittrail of bank account transfer verifyamountoutput <> object result of the amount transferred to the bank account amountmatch string whether the amount matches or not for bank account verification(yes/no) owername string name of the owner of the bank account mobile string mobile no of the account holder contract <> object contract signed by the investor signedcontract string url of the uploaded contract signed by the investor info <> object information of the investor name string name of the investor dob string dob of the investor emailid string emailid of the investor communicationaddress string communicationaddress of the investor residentialstatus string residentialstatus of the investor citizenshipcountrycode string citizenshipcountrycode of the investor citizenshipcountry string citizenshipcountry of the investor permanentaddress string permanentaddress of the investor overalstatus string overalstatus in verification results of id card(safe/ risky/ uncertain) bankaccount string bank account status in verification results of id card(safe/ risky/ uncertain) amlstatus string amlstatus in verification results of id card(safe/ risky/ uncertain) status string status for various id card(safe/ risky/ uncertain) type string type of id card(pan, dl, voterid, aadhaar, passport) purpose string purpose present in the id card number string id number of the id card url string url of video matchimage string image url to be matched to the video signzyverifiablestring string random string that is shown to read for video verification matchaudioscore string percentage of match exif <> object metadata for video verification forensics <> object forensics data for video verification fatca <> object fatca declaration by the investor pep string investor is a politically exposed person or not rpep string investor is related to a politically exposed person or not residentfortaxinindia string residence for tax purposes in jurisdiction(s) outside india? addresscity string city name of the jurisdiction and this field is present when the application is a non resident indian for tax purposes addressdistrict string district name of the jurisdiction and this field is present when application is a non resident indian for tax purposes addressstate string state name of the jurisdiction and this field is present when application is a non resident indian for tax purposes addressstatecode string state code of the jurisdiction and this field is present when application is a non resident indian for tax purposes addresscountry string country name of the jurisdiction and this field is present when application is a non resident indian for tax purposes addresscountrycode string country code of the jurisdiction and this field is present when application is a non resident indian for tax purposes addresspincode string pincode of the jurisdiction and this field is present when application is a non resident indian for tax purposes address string address of the jurisdiction and this field is present when application is a non resident indian for tax purposes countrycodejurisdictionresidence string country code jurisdiction residence of the jurisdiction and this field is present when application is a non resident indian for tax purposes countryjurisdictionresidence string country jurisdiction residence of the jurisdiction and this field is present when application is a non resident indian for tax purposes taxidentificationnumber string tax identification number of the jurisdiction and this field is present when application is a non resident indian for tax purposes placeofbirth string place of birth of the jurisdiction and this field is present when application is a non resident indian for tax purposes countrycodeofbirth string country code of birth of the jurisdiction and this field is present when application is a non resident indian for tax purposes countryofbirth string country of birth of the jurisdiction and this field is present when application is a non resident indian for tax purposes signatureimageurl string url of investor signature image formdata <> object form data block gender string kyc holder's gender type maritalstatus string kyc holder's marital status nomineerelationship string relationship with kyc holder f (father) & s (spouse) nomineetitle string title for father/spouse maidentitle string title for maiden this field is mandatory if the gender is female maidenname string name for maiden this field is mandatory if the gender is female pannumber string pan number of kyc holder aadhaarnumber string aadhaar number of kyc held mothertitle string title for mother occupationdescription string occupation type of kyc holder occupationcode string occupation code of kyc holder kycaccountcode string kyc account code of the kyc holder kycaccountdescription string kyc account type of the kyc holder communicationaddresscode string address code of the kyc holder communicationaddresstype string address type of the kyc holder nomineename string kyc holder's father/spouse name mothername string kyc holder's mother's name countrycode string country code of the permanent address mobilenumber string mobile number of the kyc holder emailid string email id of the kyc holder pincode string pincode of the communication/permanent address communicationaddress string address of the kyc holder formfilleddata <> object the form filled data object can be used to collect data supplied by the user before the verification engine is called merchantcamsjson <> object investors' data parsed in cams json to know the explanation of all the fields present in merchantcamsjson (data of the merchant parsed in the format required by cams), please refer to this link click here 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