Partner Create Merchant API
5 min
introduction 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 ) sample request curl location 'https //{base url}/api/distributors/createmerchant' \\ \ header 'content type application/json' \\ \ header 'authorization ey nleezm6jbcl8' \\ \ data raw '{ "realmid" "62 94", "realm" " realm ", "name" " name ", "email" " email ", "mobile" " mobile ", "flowid" "62 56", "signzyappid" "dh 25" }' request field description key required/optional data type description header content type required string application/json authorization required string authorization token body realmid required string this is an identifier used by the go platform, the same will be provided by the signzy team realm required string realm returned from the login request name required string name of the partner email required string email id of the partner mobile required string mobile number of the partner flowid required string flow that is assigned to the partner signzyappid required string this is the reference id that is used to identify the application sample response { "id" "64 c7", "name" " name ", "email" " email ", "mobile" " mobile ", "username" " username ", "flowid" "62 56", "realm" " realm ", "applicationid" "62 94", "distributorid" "62 31", "backopsuserid" "", "realmid" "62 94", "signzyappid" "dh 25", "autogeneratedusername" true, "regex" "", "onboardingstartdate" 1690983052861, "status" "new", "flowdetails" { "name" " flowname ", "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" } response field description 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 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