Onboarding APIs
Execute POA
15min
extraction api for poa documents endpoint /api/onboardings/execute headers property value content type application/json authorization …access token… (alphanumeric string of length 64) input { "merchantid" " ", "inputdata" { "service" "identity", "type" "aadhaar / passport / drivinglicence / voterid", "task" "autorecognition", "data" { "images" \[ " direct url to the images ", " direct url to the images " ], "toverifydata" {}, "searchparam" {}, "prooftype" "address" } } } property data type example values merchantid string ( required ) alphanumeric string of length 24 userid from investor login response inputdata object ( required ) metadata along with actual payload to be executed upon – service enum string ( required ) “identity” – type enum string ( required ) “aadhaar”/“passport”/“drivinglicence”/“voterid” – task enum string ( required ) “autorecognition” – data object ( required ) payload — images array ( required ) array of length 2(in case of 'aadhaar', 'voterid', 'passport'), length 1 or 2 (in case of dl) with valid urls an array of image urls of the id card, front and back in order in the case of pan, pass the url of the front image, and in the case of driving license pass urls of either front or both sides of images — prooftype enum string ( required ) “address” input for offline aadhaar { "merchantid" " ", "inputdata" { "service" " ", "type" "aadhaar", "task" "offlineaadhaar", "data" { "images" \[], "url" " url of zip or xml file (only for offlineaadhaar) ", "password" " password of the zip file (only for offlineaadhaar and zip file) ", "toverifydata" {}, "searchparam" {}, "prooftype" "address" } } } property data type example values merchantid string ( required ) alphanumeric string of length 24 userid from investor login response inputdata object ( required ) metadata along with actual payload to be executed upon – service enum string ( required ) “identity” – type enum string ( required ) “aadhaar” – task enum string ( required ) “offlineaadhaar” – data object ( required ) payload — images array ( required ) empty array in the case of offline aadhaar pass empty array \[] — url enum string ( required ) “url of zip or xml file ” — password enum string ( required ) “password of the zip file ( required only if the file is zip) ” — prooftype enum string ( required ) “address” for aadhaar, dl digilocker must hit the execute api twice, 1\) first with the task as createurl 2\) in response, will receive a url to grant permission from digilocker to access the documents 3\) after completion of the process, hit the same api with the task as getdetails input { "merchantid" " ", "inputdata" { "service" " ", "type" " ", "task" " creaturl/getdetails ", "data" { "images" \[], "toverifydata" {}, "searchparam" {}, "prooftype" "address" } } } property data type example values merchantid string ( required ) alphanumeric string of length 24 userid from investor login response inputdata object ( required ) metadata along with actual payload to be executed upon – service enum string ( required ) “identity” – type enum string ( required ) “aadhaardigilocker” / “dldigilocker” – task enum string ( required ) “createurl” / “getdetails” – data object ( required ) payload — images array ( required ) empty array in the case of aadhaar digilocker pass an empty array \[] — prooftype enum string ( required ) “address” expected output in case of aadhaar card { "object" { "result" { "uid" " 00000000xxxx masked first eight digit ", "vid" " virtual uid ", "name" " name on id card ", "yob" " year of birth ", "dob" " date of birth ", "pincode" " pincode ", "address" " address as on card ", "gender" "male/female", "splitaddress" { "district" \[], "state" \[ \[] ], "city" \[], "pincode" " ", "country" \[ "in", "ind", "india" ], "addressline" "" }, "uidhash" "secure cryptographic conversion of uid" } } } in case of driving license { "object" { "result" { "issuedate" "date of issue", "dob" "dob", "expirydate" "date of expiry", "name" "name", "number" "dl number", "guardianname" "name of guardian", "address" "address", "splitaddress" { "state" \[ \[] ], "district" \[], "city" \[], "pincode" " pincode ", "country" \[ "in", "ind", "india" ], "addressline" " addressline " }, "dltype" \["array of vehicle class"] } } } in case of passport { "object" { "result" { "parentsguardianname" " parentsguardianname ", "issuedate" " issuedate ", "expirydate" " expirydate ", "birthdate" " birthdate ", "name" " name ", "country" \[ " country " ], "nationality" " nationality ", "sex" "f/m", "address" " address ", "pincode" " pincode ", "passportnumber" " passportnumber ", "filenumber" " filenumber ", "placeofbirth" " placeofbirth ", "placeofissue" " placeofissue ", "splitaddress" { "district" \[ " district " ], "state" \[ \[ " state " ] ], "city" \[ " city " ], "pincode" " pincode ", "country" \[ "in", "ind", "india" ], "addressline" " addressline " } } } } in case of voterid { "object" { "result" { "epicnumber" " epic number ", "name" " name ", "fathername" " father name ", "state" " state name ", "dob" " date of birth ", "yob" " year of birth ", "ageason" " age in year ", "address" " address found on card ", "splitaddress" { "district" \[ " name of district " ], "state" \[ \[ " name of state ", "wb" ] ], "city" \[ " name of the city " ], "pincode" " pincode of the city ", "country" \[ "in", "ind", "india" ], "addressline" " address line on the card " } } } } in case of offline aadhaar { "object" { "result" { "name" " name on id card ", "yob" " year of birth ", "dob" " date of birth ", "gender" "male/female", "emailhash" " ", "mobilenohash" " ", "address" " ", "photo" " image url ", "generationdate" " date ", "generationtime" " time ", "unixtimestamp" 1589445464, "datedifference" 1, "splitaddress" { "district" \[], "state" \[ \[] ], "city" \[], "pincode" " ", "country" \[ "in", "ind", "india" ], "addressline" "" }, "x509data" { "subjectname" " ", "certificate" "", "details" { }, "validaadhaardsc" " yes/no " } } } } in case of digilocker(aadhaar/dl) 1st step { "result" { "url" " url to permit digilocker account ", "requestid" " id " } } in case of digilocker(dl) 2nd step, the response will be similar to the respective cards as mentioned above in case of aadhaar digilocker 2nd step { "result" { "type" "aadhaardigilocker", "input" { "images" \[ " image " ] }, "category" null, "output" { "uid" " 00000000xxxx masked first eight digit ", "vid" " virtual uid ", "name" " name on id card ", "yob" " year of birth ", "dob" " date of birth ", "pincode" " pincode ", "address" " address as on card ", "gender" "male/female", "splitaddress" { "district" \[], "state" \[ \[] ], "city" \[], "pincode" " ", "country" \[ "in", "ind", "india" ], "addressline" "" }, "uidhash" "secure cryptographic conversion of uid" "x509data" { "subjectname" "", "certificate" "", "details" { }, "validaadhaardsc" " yes/no " }, "photo" " image " } } } 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