Pull Onboarding Detail

endpoint post /api/onboardings/pullonboardings headers property value content type application/json authorization …channel’s access token… input (for fetch by onboarding status) { "channelid" " channelid ", "limitlength" 10, "skiplength" 0, "status" "accepted" } property data type example values channelid string channel id limitlength integer limit to number of onboardings that are returned (helpful in pagination) skiplength integer skip these many onboardings before generating the list of onboardings status string status of onboarding wanted to be pulled (all/pending/accepted/rejected) input (for fetch by onboarding id) { "channelid" " channelid ", "onboardingid" " onboardingid ", "extrafields" \[" cams "] } property data type example values channelid string channel id onboardingid string onboarding id extrafields array(optional) extrafields required to be appended in response (possible values 'cams’) expected output { "customerid" " ", "status" " ", "limitlength" " ", "skiplength" " ", "id" 4, "instanceid" " ", "result" \[{ "email" " ", "phone" " ", "name" " ", "username" " ", "customerid" " ", "merchantid" " ", "status" " ", "reason" " ", "verificationdata" { "idcards" \[{ "type" " ", "purpose" \[ "poi" ], "name" " ", "idno" " ", "dob" " ", "address" " ", "state" " ", "issuedate" " ", "images" \[ " " ], "verificationstatus" { "verification" true, "message" " ", "isset" 1 }, "faceextraction" { "isset" 1 } }, { "purpose" \[ "poa" ], "name" " ", "idno" " ", "dob" " ", "address" " ", "state" " ", "issuedate" " ", "images" \[ " ", " " ], "pincode" " ", "type" " ", "verificationstatus" { "isset" 1 }, "faceextraction" { "cropped" " ", "isset" 1 } }], "documents" \[{ "type" " ", "beneficiarymobile" " ", "beneficiaryaccount" " ", "beneficiaryname" " ", "beneficiaryifsc" " ", "images" \[ " " ] }, { "type" " ", "beneficiarymobile" " ", "beneficiaryaccount" " ", "beneficiaryname" " ", "beneficiaryifsc" " ", "images" \[], "banktransferoutput" { "active" " ", "namematch" " ", "mobilematch" " ", "signzyreferenceid" " ", "audittrail" { "nature" " ", "value" " ", "timestamp" " z" }, "banktransfer" { "response" " ", "bankrrn" " ", "benename" " ", "benemmid" " ", "benemobile" " ", "beneifsc" " 9" } }, "verifyamountoutput" { "amountmatch" " ", "owername" " ", "mobile" " ", "mmid" " 1" } }], "video" { "url" " ", "matchimage" " ", "signzyverifiablestring" " ", "seconds" \[ "00 00 02", "00 00 03", "00 00 04" ], "videomatch" { "matchaudioscore" " ", "isset" 1 }, "matchimageela" { "task" " ", "essentials" { "url" " " }, "id" " ", "patronid" " ", "result" " ", "isset" 1 }, "forensics" { "staticrisk" { "staticphoto" false, "agegroup" " ", "isset" 1 }, "videolandmarks" { "result" " ", "isset" 1 }, "videofacematch" { "videoimages" \[ "https //preproduction persist signzy tech/api/files/64344/download/r2jhdpywwvt3qgrew6bbqa8efml2qsyp7unxzhlsnjbm2vc5kj jpg", "https //preproduction persist signzy tech/api/files/64345/download/bkencx31h0hevpqtphuv7pregomsyjlznoi5salkrby2zgjgqn jpg", "https //preproduction persist signzy tech/api/files/64347/download/12kwse9ejhh1q517rab4oz2srxv3hefoaai9bm0zzfpbakox4m jpg" ], "finalmatchimage" " ", "matchstatistics" { "covariance" " ", "matchpercentage" " %" }, "isset" 1 }, "exif" { "metadatafound" " ", "message" " ", "image" {}, "gps" {}, "isset" 1 } }, "facelandmarks" { "result" " ", "isset" 1 } }, "contract" { "signedcontract" " f" }, "photo" {}, "fatca" { "pep" " ", "rpep" " ", "residentfortaxinindia" " ", "relatedperson" " o" }, "signature" { "signatureimageurl" " " }, "formdata" { "gender" " ", "maritalstatus" " ", "nomineerelationship" " ", "maidentitle" " ", "mothertitle" " ", "occupationtype" " ", "maidenname" " ", "mothername" " ", "applicationstatus" " ", "countrycode" 91, "emailid" " ", "pincode" 560078, "kycaccounttype" " ", "mobilenumber" " ", "communicationaddress" " ", "nomineetitle" " ", "nomineename" " a", "annualincome" " refer table 1 8", "placeofbirth" " " }, "info" { "name" " ", "dob" " ", "emailid" " ", "phone" " ", "communicationaddress" " ", "permanentaddress" " " } }, "formfilleddata" { "identityproof" { "type" " ", "purpose" \[ "poi" ], "name" " ", "idno" " ", "dob" " ", "expirydate" " ", "verify" " ", "address" " ", "state" " ", "issuedate" " ", "images" \[ " " ], "prooftype" " f" }, "addressproof" \[{ "purpose" \[ "poa" ], "name" " ", "idno" " ", "dob" " ", "verify" " ", "address" " ", "expirydate" " ", "state" " ", "issuedate" " ", "addresstype" " ", "prooftype" " ", "images" \[ " ", " " ], "pincode" " ", "type" " t" }], "bankaccount" { "type" " ", "images" \[ " " ] }, "formfields" { "gender" " ", "maritalstatus" " ", "nomineerelationship" " ", "maidentitle" " ", "mothertitle" " ", "occupationtype" " ", "maidenname" " ", "mothername" " ", "applicationstatus" " ", "countrycode" 91, "emailid" " ", "pincode" 560078, "kycaccounttype" " ", "mobilenumber" " ", "communicationaddress" " ", "nomineetitle" " ", "nomineename" " a", "annualincome" " refer table 1 8", "placeofbirth" " " }, "fatca" { "pep" " ", "rpep" " ", "residentfortaxinindia" " ", "relatedperson" " o" }, "signature" { "signatureimageurl" " " }, "photo" {}, "video" { "url" " ", "matchimage" " ", "signzyverifiablestring" " ", "seconds" \[ "00 00 02", "00 00 03", "00 00 04" ] }, "contract" { "signedcontract" " f" } }, "verificationresult" { "idcards" \[{ "status" " ", "type" " ", "purpose" " ", "number" " ", "businessflag" 0 }, { "status" " ", "type" " ", "purpose" " ", "number" " ", "businessflag" 0 }], "bankaccount" " ", "video" " ", "amlstatus" " ", "overalstatus" " y" } }, { "email" " ", "phone" " ", "name" " ", "username" " ", "customerid" " ", "merchantid" " ", "status" " ", "reason" " ", "verificationdata" { "idcards" \[], "documents" \[], "video" {}, "contract" {}, "photo" {}, "fatca" {}, "signature" {}, "formdata" {} }, "formfilleddata" { "identityproof" {}, "addressproof" \[], "bankaccount" { "type" " n" }, "formfields" {}, "fatca" {}, "signature" {}, "photo" {}, "video" { "url" " ", "matchimage" " ", "signzyverifiablestring" " ", "seconds" " " }, "contract" {} }, "verificationresult" {} }, { "email" " ", "phone" " ", "name" " ", "username" " ", "customerid" " ", "merchantid" " ", "status" " ", "reason" " ", "verificationdata" { "idcards" \[{ "type" " ", "purpose" \[ "poi" ], "name" " ", "idno" " ", "dob" " ", "address" " ", "state" " ", "issuedate" " ", "images" \[ " " ], "verificationstatus" { "verified" true, "message" " ", "upstreamname" " ", "isset" 1 }, "faceextraction" { "cropped" " ", "isset" 1 } }, { "purpose" \[ "poa" ], "name" " ", "idno" " ", "dob" " ", "address" " ", "state" " ", "issuedate" " ", "images" \[ " " ], "pincode" " ", "type" " ", "verificationstatus" { "message" " ", "verified" true, "moreinfo" { "issuedate" " ", "expirydate" " ", "vehicleclass" \[ "lmv" ] }, "instance" {}, "isset" 1 }, "faceextraction" { "cropped" " ", "isset" 1 } }], "documents" \[], "video" { "url" " ", "matchimage" " ", "signzyverifiablestring" " ", "seconds" \[ "00 00 02", "00 00 04", "00 00 06", "00 00 08" ], "videomatch" { "matchaudioscore" " ", "isset" 1 }, "matchimageela" { "task" " ", "essentials" { "url" " " }, "id" " ", "patronid" " ", "result" " ", "isset" 1 }, "forensics" { "staticrisk" { "staticphoto" false, "agegroup" " ", "isset" 1 }, "videolandmarks" { "result" " ", "isset" 1 }, "videofacematch" { "videoimages" \[ "https //preproduction persist signzy tech/api/files/123/download/videoimage jpg", "https //preproduction persist signzy tech/api/files/456/download/videoimage jpg", "https //preproduction persist signzy tech/api/files/789/download/videoimage jpg", "https //preproduction persist signzy tech/api/files/234/download/videoimage jpg" ], "finalmatchimage" " ", "matchstatistics" { "covariance" " ", "matchpercentage" " %" }, "isset" 1 }, "exif" { "metadatafound" " ", "message" " ", "image" {}, "gps" {}, "isset" 1 } }, "facelandmarks" { "result" " ", "isset" 1 } }, "contract" {}, "photo" {}, "fatca" { "pep" " ", "rpep" " ", "residentfortaxinindia" " ", "relatedperson" " o" }, "signature" { "signatureimageurl" " " }, "formdata" { "gender" " ", "maritalstatus" " ", "nomineerelationship" " ", "maidentitle" " ", "pannumber" " ", "aadhaarnumber" " ", "mothertitle" " ", "occupationdescription" " ", "occupationcode" " ", "kycaccountcode" " ", "kycaccountdescription" " ", "communicationaddresscode" " ", "communicationaddresstype" " ", "applicationstatuscode" " ", "applicationstatusdescription" " ", "countrycode" " ", "mobilenumber" " ", "emailid" " ", "communicationaddress" " ", "pincode" " ", "mothername" " ", "nomineetitle" " ", "nomineename" " a" }, "info" { "name" " ", "dob" " ", "emailid" " ", "phone" " ", "communicationaddress" " ", "permanentaddress" " " } }, "formfilleddata" { "identityproof" { "type" " ", "purpose" \[ "poi" ], "name" " ", "idno" " ", "dob" " ", "expirydate" " ", "verify" " ", "address" " ", "state" " ", "issuedate" " ", "images" \[ " " ], "prooftype" " f" }, "addressproof" \[{ "purpose" \[ "poa" ], "name" " ", "idno" " ", "dob" " ", "verify" " ", "address" " ", "expirydate" " ", "state" " ", "issuedate" " ", "addresstype" " ", "prooftype" " ", "images" \[ " " ], "pincode" " ", "type" " l" }], "bankaccount" { "type" " n" }, "formfields" { "gender" " ", "maritalstatus" " ", "nomineerelationship" " ", "maidentitle" " ", "pannumber" " ", "aadhaarnumber" " ", "mothertitle" " ", "occupationdescription" " ", "occupationcode" " ", "kycaccountcode" " ", "kycaccountdescription" " ", "communicationaddresscode" " ", "communicationaddresstype" " ", "applicationstatuscode" " ", "applicationstatusdescription" " ", "countrycode" " ", "mobilenumber" " ", "emailid" " ", "communicationaddress" " ", "pincode" " ", "mothername" " ", "nomineetitle" " ", "nomineename" " a" }, "fatca" { "pep" " ", "rpep" " ", "residentfortaxinindia" " ", "relatedperson" " o" }, "signature" { "signatureimageurl" " " }, "photo" {}, "video" { "url" " ", "matchimage" " ", "signzyverifiablestring" " ", "seconds" \[ "00 00 02", "00 00 04", "00 00 06", "00 00 08" ] }, "contract" {} }, "verificationresult" { "idcards" \[{ "status" " ", "type" " ", "purpose" " ", "number" " ", "businessflag" 0 }, { "status" " ", "type" " ", "purpose" " ", "number" " ", "businessflag" 0 }], "bankaccount" " ", "video" " ", "amlstatus" " ", "overalstatus" " y" } }] } 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