BizKitHub
DocsInteractive API Docs/api/v1/customer/login
post

/api/v1/customer/login

Create a new customer identity based on real customer e-mail and password. Return identity session value or error code.

List of error codes:

Code Message
E001 Customer login failed.
E002 Customer e-mail does not exist.
E003 Customer have not a registered account.
E004 Wrong e-mail or password.
E005 Customer account has been banned.
E006 Too many login attempts.
E007 Customer mail has not been authorized.
Endpoint Info
Base URLapi.bizkithub.com
AuthBearer Token
Methods1
Authentication Required

This endpoint requires a valid API key passed as a query parameter or Bearer token.

Get your API key

Parameters

1 query, 3 body parameters

apiKeystringrequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

emailstringrequired

Contact email address.

The system validates the input as a standard email address and automatically applies normalization and canonicalization.

All API responses return the normalized form, and each email address is globally unique per contact within the system.

passwordstringrequired
customerRealIpstring

User IP address used for GEO/IP intelligence.
Accepted formats: IPv4 (e.g. 1.1.1.1), IPv6 (e.g. 2001:4860:4860::8888)
Normalization:

  • ::1, 0.0.0.0, localhost (or empty value) is normalized to 127.0.0.1
  • Invalid values are rejected (the API expects a valid IP string).

If provided, the system can resolve additional context (reverse DNS, geolocation, ASN, proxy/hosting flags) via our internal VikiTron GEO/IP resolver. Learn more

Example Request

JavaScript fetch

const response = await fetch("https://api.bizkithub.com/api/v1/customer/login?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "email": "jan@barasek.com",
    "password": "1234",
    "customerRealIp": "1.1.1.1"
  })
});

const data = await response.json();
console.log(data);
post

Example Response

200Success
{
  "success": true,
  "identityId": "9jq49ZE1xoKI7S5ys4J0a70y3Xp2hQqc"
}

cURL

Command line example

curl -X POST "https://api.bizkithub.com/api/v1/customer/login?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "jan@barasek.com",
  "password": "1234",
  "customerRealIp": "1.1.1.1"
}'

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key
Back to API DocumentationAPI Reference