Pull Merchant API (Partner)
5 min
introduction if a client wants to get the data for a specific merchant, then call this api with the merchant id that was generated in the create merchant api sample request curl location 'https //{base url}/api/distributors/pullmerchant/{merchant id}?realmid={realm id}\&version=1 1 0' \\ \ header 'authorization e 8' request field description key required/optional data type description authorization required string authorization token sample response { "result" { "merchantsignup" {}, "merchantdata" { "basicdetails" { "id" "64 c7", "name" " name ", "email" " email ", "mobile" " mobile ", "username" " username ", "realm" " realm ", "applicationid" "62 94", "distributorid" "62 31", "isdeleted" false, "backopsuserid" "", "realmid" "62 94", "signzyappid" "dh 25", "autogeneratedusername" true, "regex" "", "onboardingstartdate" 1690983052861, "status" "pending", "flowdetails" { "name" " name ", "type" " type " }, "autologinurl" "https //{base url}/realm/al/rul fjnq", "loginurl" "https //{base url}/realm/login", "shortloginurl" "https //{base url}/realm/login", "shortautologinurl" "https //{base url}/realm/al/rul fjnq", "eventsource" "webapp", "eventstatus" "onboardingcompleted", "initialsubmissiondate" 1690983191120, "onboardingenddate" 1690983191120, "substatus" "allkycdone", "decisionengineresult" "uncertain", "internalnotes" \[], "backopsuserdetails" {} }, "documents" \[ { "aadhaarimage1" "file url", "aadhaarname" "name", "aadhaaruid" "uid", "aadhaarvid" "vid", "aadhaardob" "date of birth", "aadhaaryob" "year of birth", "aadhaarpincode" "pincode", "aadhaaraddress" "address", "aadhaargender" "gender", "aadhaaruidhash" "uid hash", "aadhaarstate" "state", "aadhaardistrict" "district", "aadhaarcity" "city", "aadhaarcountry" "country", "type" "digilocker aadhaar", "widgetname" "digilocker aadhaar" }, { "pantogstapplicationstatus" "application status", "pantogstregistrationname" "registration name", "pantogstmobnum" "mobile number", "pantogstregtype" "registration type", "pantogstemailid" "email id", "pantogsttinnumber" "tin number", "pantogstgstinrefid" "gstin refid", "pantogstgstin" "gstin", "pantogstconstitutionofbusiness" "constitution of business", "pantogstlegalnameofbusiness" "legal name of business", "pantogsttradenameofbusiness" "trade name of business", "pantogstcentrejurisdiction" "centre jurisdiction", "pantogststatejurisdiction" "state jurisdiction", "pantogstregistrationdate" "registration date", "pantogsttaxpayerdate" "tax payer date", "pantogsttaxpayertype" "tax payer type", "pantogstgstinstatus" "gstin status", "pantogstcancellationdate" "cancellation date", "pantogstnatureofbusinessactivities" "nature of business activities", "pantogstprincipalplaceaddress" "principal place address", "pantogstprincipalplacelatitude" "principal place latitude", "pantogstprincipalplacelongitude" "principal place longitude", "pantogstprincipalplacebuildingnamefromgst" "principal place building name from gst", "pantogstprincipalplacebuildingnofromgst" "principal place building no from gst", "pantogstprincipalplaceflatno" "principal place flat no", "pantogstprincipalplacestreet" "principal place street", "pantogstprincipalplacelocality" "principal place locality", "pantogstprincipalplacecity" "principal place city", "pantogstprincipalplacedistrict" "principal place district", "pantogstprincipalplacestate" "principal place state", "pantogstprincipalplacepincode" "principal place pincode", "pantogstadditionalplaceaddress" "additional place address", "pantogstadditionalplacelatitude" "additional place latitude", "pantogstadditionalplacelongitude" "additional place longitude", "pantogstadditionalplacebuildingnamefromgst" "additional place building name from gst", "pantogstadditionalplacebuildingnofromgst" "additional place building no from gst", "pantogstadditionalplaceflatno" "additional place flat no", "pantogstadditionalplacestreet" "additional place street", "pantogstadditionalplacelocality" "additional place locality", "pantogstadditionalplacecity" "additional place city", "pantogstadditionalplacedistrict" "additional place district", "pantogstadditionalplacestate" "additional place state", "pantogstadditionalplacepincode" "additional place pincode", "type" "pan to gst", "widgetname" "pan to gst" }, { "businesspanimage" "file url", "businesspanname" "name", "businesspandateofissue" "date of issue", "businesspanpannumber" "pan number", "type" "business pan", "widgetname" "business pan" } ], "formdata" { "address" "aadhaaraddress", "adhaaradress" "aadhaar address", "gstaddress" "gst address", "enteraddress" "enter address", "widgetname" "manual data entry" }, "videoforensics" { "audiomatchscore" "audio match score", "videomatchscore" "video match score", "videocovariance" "video covariance", "videofinalimage" "videoimg url persist", "videourl" "video url persist", "videootp" "video otp", "videofacelandmark" "video face landmark image url", "videoprerecordedrisk" "video pre recorded risk", "videostaticrisk" "video static risk", "videolandmark" "video landmark", "type" "video verification", "widgetname" "video verification" }, "videokyc" \[], "contract" {}, "contractsdk" {}, "products" \[], "data" \[], "browserandlocationinfo" {}, "appandlocationinfo" {}, "matcherdata" \[], "internalnotes" \[] }, "merchantauditdata" \[], "submerchantauditdata" \[] } } 400 { "error" { "statuscode" 400, "name" "error", "message" "not a valid status" } } 401 { "error" { "statuscode" 401, "name" "error", "message" "authorization required", "code" "authorization required" } } response field description key data type description merchantdata object this contains all the data of the merchant basicdetails object contains basic details of the merchant and onboarding documents array of objects contains data about documents collected in the onboarding formdata object data returned from video kyc and verification contract object contains data of digital contract products string realm returned from the backops user login flowid array of objects contains data of opted products browserandlocationinfo object contains data about merchants location and browser browserinfo object contains browser info locationinfo object contains location info based on isp matcherdata array of objects contains data of name match/text match/ address match signzyappid string signzy app id 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