Integration Guide
Create Merchant API
5 min
introduction the create merchant api creates a new merchant/customer in the system this api requires an authorisation token or id obtained from the login api in the response, the api will generate an auto login url for the customer to start their journey sample request create merchant preproduction curl location 'https //go preproduction signzy app/api/applications/66a2413c9c6205eeb0b1bf63/merchants' \\ \ header 'authorization\ ey 4ntz9 of8cb ipuxikykego8qf ukjf6p4xxxxxe4' \\ \ header 'content type application/json' \\ \ data raw '{ "email" "customer email\@gmail com", "name" "customer name", βmobileβ "9999999999", "realm" "clientname vcip", "flowid" "667a6f30e1337f1a85d024ec" } ' create merchant curl production curl location 'https //backops go onboardings co/api/applications/66796efc2a8e2bc8fd7c50da/merchants' \\ \ header 'authorization ey 4ntz9 of8cb ipuxikykego8qf ukjf6p4xxxxxe4β' \\ \ header 'content type application/json' \\ \ data raw '{ "email" "customer email\@gmail com", "name" "customer name", βmobileβ "9999999999", "realm" "clientname vcip", "flowid" "667a6f30e1337f1a85d024ec" } ' to invoke the create merchant api, include the authorization token in the header, which was obtained from the response of the login api key optional/required description email either 'email' or 'mobile' is required email id of the merchant/customer name required name of the merchant/customer mobile either 'email' or 'mobile' is required mobile number of the merchant/customer realm required realm details will be provided by the signzy team flowid required flowid details will be provided by the signzy team this is unique for different flows or jounreys which has been created in the realm sample response { "id" "6698e64a101f4a4726711dc8", "name" "customer name", "email" "customer email\@gmail com", "mobile" "9999999999", "username" "af815527", "flowid" "667a6f30e1337f1a85d024ec", "realm" "clientname vcip", "applicationid" "66796efc2a8e2bc8fd7c50da", "isdeleted" false, "backopsuserid" "", "autogeneratedusername" true, "regex" "", "onboardingstartdate" 1721296458053, "status" "new", "flowdetails" { "name" "vkyc journey", "type" "mainflow" }, "autologinurl" "https //go onboardings co/clientname vcip/al/umf6b3jwyxlfvksdsdfdfsfni", "loginurl" "https //go onboardings co/clientname vcip/login", "shortloginurl" "https //go onboardings co/clientname vcip/login", "shortautologinurl" "https //go onboardings co/clientname vcip/al/umf6b3jwyxlfvdfgasdxntuynyymm2qwmjvkoti", "signzyappid" 1000035 } key description id this is the unique id of the merchant/customer for this particular autologinurl name name of the merchant/customer email email of the merchant/customer mobile mobile number of the merchant/customer flowid the flow for which the journey link has been created realm realm name on which the autologinurl is associated with autologinurl this is the url where the merchant/customer needs to be redirected to commence the onboarding journey shortautologinurl shortened autologin url id is the unique identifier of the customer for that particular journey even if customer does multiple retries for same autologinurl, the id remains constant autologinurl is the url, where merchant/custoemer should be redirected to complete the onboarding journey note note the create merchant api can be modified as per clients requirement, the extra data whatever clients want to pass can be shared by the create merchant api and same will be shared to maker and checker for video kyc process for example, if client only wants video kyc service and needs to send the ekyc details or aadhar details and pan details or any other data, in that case the create merchant api will be configured by the signzy team as per client requirement