Callback API (Partner)

introduction the api will allow you to define event based (accept, reject, pending) callbacks for each partner these callbacks are where the json data will be posted once that event happens sample request curl location 'https //{base url}/api/distributors/callback' \\ \ header 'authorization ey nleezm6jbcl8' \\ \ header 'content type application/json' \\ \ data '{ "distributorid" "62 31", "realmid" "62 94", "flowid" "62 56", "callbacks" { "accept" "https //webhook site/6a 41" } }’ request field description key required/optional data type description header authorization required authorization token content type required string application/json body distributorid required string this is a unique identifier of the partner realmid required string this is an identifier used by the go platform, the same will be provided by the signzy team flowid required string flow that is assigned to the partner callbacks required string the callbacks are widely used to post data based on specific events defined within the go platform sample response { "merchantsignup" {}, "merchantdata" { "id" "64 95", "name" " name ", "email" " email ", "mobile" " mobile ", "username" " username ", "flowid" "62 56", "realm" " realm ", "applicationid" "62 94", "distributorid" "62 31", "isdeleted" false, "backopsuserid" "", "realmid" "62 94", "signzyappid" "dh 25", "autogeneratedusername" true, "regex" "", "onboardingstartdate" 1690801598765, "status" "accept", "flowdetails" { "name" " flowname ", "type" " flowtype " }, "autologinurl" "https //{base url}/eir/al/rul zg", "loginurl" "https //{base url}/eir/login", "shortloginurl" "https //{base url}/eir/login", "shortautologinurl" "https //{base url}/eir/al/rul zg", "eventsource" "webapp", "eventstatus" "onboardingcompleted", "initialsubmissiondate" 1690801883951, "onboardingenddate" 1690801883951, "substatus" "notescalated", "decisionengineresult" "uncertain", "actionby" "eir backops1", "actiontime" 1690983815934, "backopsuser" { "id" "62 fa", "name" " name ", "username" " username ", "email" " email ", "password" " password ", "mobile" " mobile ", "realm" " realm ", "isdormant" false, "applicationid" "62 94", "managertoggle" null, "manager" null, "managername" null, "profilesettings" { "timezonevalue" "asia/kolkata", "dateformat" "dd/mm/yyyy", "timeformat" "hh\ mm\ ss" }, "jobtimestamp" null, "employeecode" null, "designationid" null, "assignment" { "count" 0, "actiontaken" 0 }, "invalidloginattempt" 0, "invalidloginattemptsession" null, "lastloginat" 1690983469213, "passwordlastmodifiedon" 1658835716597, "lastlogoutat" 1689607873794 }, "designation" "", "draftscount" 0, "instructions" "", "reason" "", "internalnotes" \[ { "id" "64 6e", "message" { "instructions" "", "subject" "accept", "reason" "" }, "logtime" "2023 08 02t13 43 35 942z", "type" "logs", "merchantid" "64 95", "action" "accept", "escalatelog" "application escalated", "actionby" "eir backops1", "backopsuserid" "62 fa", " id" "64 6e" } ], "data" \[ { "id" "64 44", "pageid" "62 4f", "flowid" "62 56", "data" { "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" }, "merchantid" "64 95", "applicationid" "62 94", "pagename" "aadhaar upload", "uid" "64 95", "type" " type ", "widgetname" " widget name ", "pagetype" " page type ", "issubflow" false, " id" "64 44" }, { "id" "64 46", "pageid" "62 50", "flowid" "62 56", "data" { "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" }, "merchantid" "64 95", "applicationid" "62 94", "pagename" "pan to gst", "uid" "64 95", "type" "pan to gst", "widgetname" "pan to gst", "pagetype" "data\&document", "issubflow" false, " id" "64 46" }, { "id" "64 47", "pageid" "62 fa", "flowid" "62 56", "data" { "address" "aadhaaraddress", "adhaaradress" "aadhaar address", "gstaddress" "gst address", "enteraddress" "enter address", "type" "manual data entry", "widgetname" "manual data entry" }, "merchantid" "64 95", "applicationid" "62 94", "pagename" "address details", "uid" "64 95", "type" "manual data entry", "widgetname" "manual data entry", "pagetype" "manual data entry", "issubflow" false, " id" "64 47" }, { "id" "64 48", "pageid" "62 9e", "flowid" "62 56", "data" { "audiomatchscore" "audio match score", "videomatchscore" "video match score", "videocovariance" "video covariance", "videofinalimage" {url}, "videourl" {url}, "videootp" {url}, "videofacelandmark" "video face landmark image url", "videoprerecordedrisk" "video pre recorded risk", "videostaticrisk" "video static risk", "videolandmark" "video landmark", "type" "video verification", "widgetname" "video verification" }, "merchantid" "64 95", "applicationid" "62 94", "pagename" "video verification", "uid" "64 95", "type" "video verification", "widgetname" "video verification", "pagetype" "video verification", "issubflow" false, " id" "64 48" }, { "id" "64 49", "pageid" "62 41", "flowid" "62 56", "data" { "businesspanimage" "file url", "businesspanname" "name", "businesspandateofissue" "date of issue", "businesspanpannumber" "pan number", "type" "business pan", "widgetname" "business pan" }, "merchantid" "64 95", "applicationid" "62 94", "pagename" "business pan", "uid" "64 95", "type" "business pan", "widgetname" "business pan", "pagetype" "data\&document", "issubflow" false, " id" "64 49" } ], "backopsuserdetails" \[], " id" "64 95" }, "matcherdata" \[], "merchantauditdata" \[], "submerchantauditdata" \[] } key data type description id string this is your access token to be passed into other endpoints as an authorization header name string name of the partner email string email id of the partner mobile string mobile number of the partner username string username of the partner flowid string flow that is to be assigned to the partner realm string realm returned from the login request applicationid string this is a realm identifier, to be given by the signzy team distributorid string this is a unique identifier of the partner backopsuserid string user id for the backops portal realmid string this is an identifier used by the go platform, the same will be provided by the signzy team signzyappid string this is the reference id that is used to identify the application autogeneratedusername string the username can be either created manually or can be auto generated this field is true if the username is auto generated and false if not regex string if there is any regex impression attached to the username it is shown here onboardingstartdate string start date of the onboarding journey status string the current status of the application by default, this is "new" for a newly created application flowdetails string details of the assigned flow name string name of the flow type string type of the flow autologinurl string this is the url where the partner needs to be redirected to commence the onboarding journey shortautologinurl string shortened autologin url 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