DocsInteractive API Docs/api/v1/customer/detail
get

/api/v1/customer/detail

API endpoint documentation

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

4 query 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

identityIdstringrequired

Logged user identity (from your frontend cookies). Learn more

cuRefNostringrequired

cuRefNo = customer reference number.

Length: 16 - 16
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/detail?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&identityId=Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg&cuRefNo=1cGIHvFoQDGLAbcA&customerRealIp=1.1.1.1", {
  method: "GET",
  headers: {
    "Content-Type": "application/json"
  }
});

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

Example Response

200Success
{
  "loggedIn": true,
  "cuRefNo": "1cGIHvFoQDGLAbcA",
  "creditBalance": 123,
  "email": "jan@barasek.com",
  "phone": "+420 777123456",
  "firstName": "Jan",
  "lastName": "Barášek",
  "companyName": "BizKitHub",
  "premium": true,
  "ban": false,
  "groups": [
    {
      "name": "Personal Trainer",
      "slug": "trainer"
    }
  ],
  "meta": {},
  "referral": {
    "code": "1cGIHvFoQDGLAbcA",
    "email": "jan@barasek.com",
    "firstName": "Jan",
    "lastName": "Barášek"
  },
  "runningSubscriptionList": [
    {
      "externalId": "d9DfQL3ZF01t7Ykk",
      "productSlug": "predplatne-rocni",
      "productCode": "predplatne-rocni",
      "orderNumber": "25000001",
      "orderHash": "CuS08iXV3cOwweQsQB3TwYXtDr67K4kW",
      "autoRenew": true
    }
  ]
}

cURL

Command line example

curl -X GET "https://api.bizkithub.com/api/v1/customer/detail?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&identityId=Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg&cuRefNo=1cGIHvFoQDGLAbcA&customerRealIp=1.1.1.1" \
  -H "Content-Type: application/json"

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key