Partner Ecosystem

7 min

overview this document aims to provide relevant information for calling signzy's partner apis this api set facilitates the sending of onboarding user data to signzy's back office (backops) dashboard this document will help you with detailed information about every component involved in this process, followed by sample json requests and responses api workflow step 1 partner creation docid 2gyokuknqytkvu gofmxy end point \'https //{base url}/api/distributors'\ this api is used to create the credentials for the partner and generate the access token to make further api calls step 2 log in docid\ fw1yrpi1vlwei6j8aijyz end point \'https //\ \{base url}\ \/api/distributors/login'\ the user logs in to the partner ecosystem with valid credentials (username and password) given to him/her this api call generates an authorization token in response, which is used as an access token for subsequent api calls step 3 linking the partner docid\ mbbefmka6rstofwx5yhkl end point \'https //\ \{base url}\ \/api/distributorlink'\ this allows partners to gain access to specific realms and flows within that realm so that applications for those flows can be pushed to signzy's back office step 4 assigning flows to partners docid\ xwe9hphefy1dszakltxce end point \'https //\ \{base url}\ \/api/applications/updatedistributorlink'\ the partner assign flow api is an api within signzy's partner ecosystem, which is used to allocate specific flow(s) to the partner step 5 creating a merchant docid\ a9fwtsexgo6bokkayzxjh end point \'https //\ \{base url}\ \/api/distributors/createmerchant'\ the api is used to create an application instance within our platform and this is created within a realm for a particular flow the api response will provide an identification of the application within the realm (the response contains the "merchant id" and "signzyappid" which can be used as a unique identifier of the application within the platform ) step 6 sending user data docid\ yhfzubakw99ny8mmes3cy end point \'https //\ \{base url}\ \/api/distributors/pushmerchant'\ after the user data is collected, it is pushed into the signzy back office dashboard this endpoint stores the results according to the merchant's data this api call should be made after the merchant has finished onboarding step 7 pull data docid\ lhsnzoa1z2mut roku a3 end point(pull details) \'https //\ \{base url}\ \/api/distributors/pullmerchant/64ca5a8cc4d83d01453778c7?realmid=62df8e46fa3308fa636ccf94\&version=1 1 0'\ end point(callback) \'https //\ \{base url}\ \/api/distributors/callback'\ if a client wants to get the data for a specific customer, then call this api with the application id that was generated in the create api this can be done in two ways partner pull details api manual data pull docid\ lhsnzoa1z2mut roku a3 partner callback api automated data push docid\ mdedqhqvjmoq yyvwhqto 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