Login API

introduction to access this api, the customer must obtain valid credentials, which will be provided by the signzy team upon request sample request here username username , password password and realm details realm details will be shared by the signzy to hit the login api upon request by the client login api curl preproduction curl location 'https //go preproduction signzy app/api/backopsusers/login' \\ \ header 'content type application/json' \\ \ data raw '{ "username" "sample\@gmail com", "password" "sample\@2024", "realm" "clientname vcip" }' login api curl production curl location 'https //backops go onboardings co/api/backopsusers/login' \\ \ header 'content type application/json' \\ \ data raw '{ "username" "sample\@gmail com", "password" "sample\@2024", "realm" "clientname vcip" }' request body descripiton key optional/required description username required username on which the instance/realm has been created password required password to access the realm realm required instance or realm created for individual clients sample response the login api authenticates the user and returns an authorization token or id authorization token or id , which is required to access other apis, such as the create merchant api response { "userid" "66912141da22feee809f5b7a", "applicationid" "669120cf134fd8dfe39c3b9a", "id" "ey 4ntz9 of8cb ipuxikykego8qf ukjf6p4xxxxxe4", "data" { "id" "66912141da22feee809f5b7a", "name" "client name", "username" "sample\@gmail com", "email" "customeremail\@signzy com”, "realm" "clientname vcip", "applicationid" "669120cf134fd8dfe39c3b9a", "profilesettings" { "timezonevalue" "asia/kolkata", "dateformat" "dd/mm/yyyy", "timeformat" "hh\ mm\ ss" }, "iscreatedbysiteadmin" true, "createdat" "2024 07 12t12 27 45 139z", "updatedat" "2024 07 12t12 27 45 139z", "invalidloginattempt" 0, "invalidloginattemptsession" null, "lastloginat" 1721293973931, "passwordlastmodifiedon" 1720787412367, "lastlogoutat" 1720802810520, "locals" { "attempts" 5 }, "grantdata" { "title" "admin", "level" 0, "grants" {} }, "theme" {}, "application" { "assignmentstrategy" "", "enablefieldcreatemerchant" "", "eydemo" false, "strategyvalues" \[], "integrationtypelist" {} }, "enduserurl" "", "cookiestorage" false, "ekycfetch" false, "backopslogoutredirecturl" false, "noforcechangepassword" false, "showdropoffbucket" false, "enablereporting" false, "analytics" false, "googleanalyticsconfig" { "enabled" false }, "realmprofilesettings" { "timezonevalue" "asia/kolkata", "dateformat" "dd/mm/yyyy", "timeformat" "hh\ mm\ ss" } }, "ismanager" false } response body description key value description id ey 4ntz9 of8cb ipuxikykego8qf ukjf6p4xxxxxe4 this is the authetication token or id which will be required to invoke other apis like create merchant api and pull merchant api realm clientname vcip realm will be set while creating the instance for the client and will remain constant multiple types of flows can be created in same realm the mapping other parameters in the response of login api, apart from id and realm can be ignored the default expiry of authentecation token or id is 14 days and can be configured as per the requirement name is mandatory field either of email or phone number is required