BizKitHub
DocsAPI ReferenceCustomer/api/v1/customer/logout
postCustomerPublic API v1

/api/v1/customer/logout

Invalidates the customer identity session and logs activity with geolocation.

customerpostApiV1CustomerLogout

Parameters

1 query · JSON body

Query parameters

· 1
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

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

Request body

application/json
identityIdstringRequired

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

ExampleZ9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg
customerRealIpstringOptional

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

Examples1.1.1.12001:4860:4860::8888

Response schema

1 status code documented

200Success
successbooleanRequired
Default: true

Response example

application/json
{
  "success": true
}

Request example

POST /api/v1/customer/logout

post
curl -X POST "https://api.bizkithub.com/api/v1/customer/logout?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "identityId": "Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg",
  "customerRealIp": "1.1.1.1"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key