Create Merchant API

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 globoff 'https //go preproduction signzy app/api/v1/applications/{{applicationid}}/merchants' \\ \ header 'authorization \<authorization token>' \\ \ header 'content type application/json' \\ \ data '{ "name" \<name>, "username" \<username>, "password" " password ", "email" " email ", "mobile" " mobile ", "realm" " realmid ", "flowid" " flowid " }' request field description key required/optional data type description path parameters applicationid required string applicationid returned from the backops user login headers authorization required string access token returned from backops login request content type required string application/json password required string password of the user body parameters flowid required string flow that is assigned to the end user name optional string name of the user username optional string username for the user password optional string password of the user mobile required string mobile number of the user email required string email of the user realm required string realm returned from the backops login request sample response 200 ok { "id" "63ec5c61d405cb001760xxxx", "name" " name ", "email" " email ", "mobile" " mob no ", "username" "cf064xx8", "flowid" "63e3b459540007001714xxxx", "realm" " realm name ", "signzyappid" "abcdxxx545", "applicationid" "628e20be9b11c5d9d418xxxx", "distributorid" "628e23439b11c5d9d418xxxx", "backopsuserid" "", "realmid" "628e20be9b11c5d9d418xxxx", "autogeneratedusername" true, "regex" "", "onboardingstartdate" 1676434529407, "status" "new", "flowdetails" { "name" " flow name", "type" "mainflow" }, "autologinurl" " url ", "loginurl" " url ", "shortloginurl" " url ", "shortautologinurl" " url " } 400 bad request { "error" { "statuscode" 400, "name" "error", "message" "realm is required", "code" "realm required" } } 401 unauthorized { "error" { "statuscode" 401, "name" "error", "message" "authorization required", "code" "authorization required" } } 404 not found { "error" { "statuscode" 404, "name" "error", "message" "shared class \\"patron\\" has no method handling post /login/1232", "status" 404 } } response field description key data type description name string name for the end user whose onboarding needs to be conducted username string username of the end user (needs to be provided for them to be able to log in) email string email for the end user whose onboarding needs to be conducted mobile string phone for the end user whose onboarding needs to be conducted realm string realm returned from the backops user login flowid string flow that is to be assigned to the end user variablen string these are predefined input parameters which the integrator needs to send to signzy before the start of the journey signzyappid string this is the reference id which is used to identify the application status string the current status of the application by default, this is "new" for a newly created application qr string this is a a qr code for starting the onboarding journey autologinurl string this is the url where the merchant 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