API: Verify client login

verifyClientLogin

Verify client login. If client with username & password exist in db, his ID will be returned. Additionally call returns mfa_status 1/0 informing if client have multi-factor auth enabled

Required parameters

Parameter	Description
email	Client email
password	Client password in plain text

Optional parameters

Parameter	Description
brand	Brand name. If the parameter is set, it checks only users from this brand
origin_ip	Client IP to be used with ban_on_failure parameter
ban_on_failure	When set to 1 and provided details are not valid, client IP will be banned after N number of failed attempts, as if login occurs from client portal.
trigger_login_event	Trigger Client logged in event (default:0)

Request

GET /admin/api.php?api_id=API_ID&api_key=API_KEY&call=verifyClientLogin&email=EMAIL&password=PASSWORD

PHP Samples

Response

{
    "success": true,
    "client_id": "1",
    "mfa_status": 0,
    "call": "verifyClientLogin",
    "server_time": 1700735975
}