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

/api/v1/customer/create

Registers a new customer or returns an existing one by email. Returns the full customer profile with a flag indicating whether a new account was created.

customerpostApiV1CustomerCreate

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
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 unique per organisation within the system.

Phone-only contacts: Since 2026-06-10 a contact may exist without an e-mail when it was registered only by phone (e.g. imports of phone-only records). Responses that expose such contacts use API_EMAIL_NULLABLE instead, where this field can be null. Endpoints that accept e-mail as input still require a valid value here — phone-only creation goes through admin-only import / BFF flows.

Examplejan@barasek.com
companyNamestringOptional
ExampleBizKitHub
companyRegistrationNumberstringOptional
Example05103118
taxIdentificationNumberstringOptional
ExampleCZ9609040727
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
success"true"Required
newAccountbooleanRequired
Exampletrue
cuRefNostringRequired

cuRefNo = customer reference number.

Length: 16–16
Example1cGIHvFoQDGLAbcA
creditBalancenumberRequired
Example123
emailstring | nullRequired
One of 2:
Variant 1
string

Contact e-mail address, or null for phone-only contacts.

When null: the contact was registered with only a phone number (no e-mail), or was anonymised via GDPR right-to-erasure. Such contacts cannot be looked up by e-mail and cannot log in (login requires e-mail). UI should fall back to the contact's name, phone, or external reference when rendering.

When non-null, the value is the canonical normalized form (fixEmail) and is unique per organisation.

Examplejan@barasek.com
Variant 2
null
phonestringOptional

Contact phone number in international (national) format.

Preferred format: +<country_code> <local_number>

  • Leading plus sign (+) is required
  • Followed by the country calling code (e.g. 420)
  • One space after the country code
  • Full local number without spaces

Example: +420 777123456
This format ensures unambiguous storage, validation, and compatibility with SMS, calling, and third-party integrations (e.g. Twilio, WhatsApp, CRM systems).

Example+420 777123456
firstNamestringOptional
ExampleJan
lastNamestringOptional
ExampleBarášek
companyNamestringOptional
ExampleBizKitHub
premiumbooleanRequired
Exampletrue
banbooleanRequired
Examplefalse
groupsobject[]Required
Each array item:
namestringRequired
ExamplePersonal Trainer
slugstringRequired
Exampletrainer
metaobjectRequired
customFieldsobjectRequired
referralobjectOptional
codestringRequired

cuRefNo = customer reference number.

Length: 16–16
Example1cGIHvFoQDGLAbcA
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 unique per organisation within the system.

Phone-only contacts: Since 2026-06-10 a contact may exist without an e-mail when it was registered only by phone (e.g. imports of phone-only records). Responses that expose such contacts use API_EMAIL_NULLABLE instead, where this field can be null. Endpoints that accept e-mail as input still require a valid value here — phone-only creation goes through admin-only import / BFF flows.

Examplejan@barasek.com
firstNamestringOptional
ExampleJan
lastNamestringOptional
ExampleBarášek
runningSubscriptionListobject[]Required
Each array item:
externalIdstringRequired
Exampled9DfQL3ZF01t7Ykk
productSlugstringRequired
Examplepredplatne-rocni
productCodestringRequired
Examplepredplatne-rocni
orderNumberstringRequired
Example25000001
orderHashstringRequired
ExampleCuS08iXV3cOwweQsQB3TwYXtDr67K4kW
autoRenewbooleanRequired
Exampletrue
renewalDateDate | string | string | numberRequired
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
activeToDateDate | string | string | numberOptional
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
lastSuccessPaymentDateDate | string | string | numberOptional
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number

Response example

application/json
{
  "success": true,
  "newAccount": true,
  "cuRefNo": "1cGIHvFoQDGLAbcA",
  "creditBalance": 123,
  "phone": "+420 777123456",
  "firstName": "Jan",
  "lastName": "Barášek",
  "companyName": "BizKitHub",
  "premium": true,
  "ban": false,
  "groups": [
    {
      "name": "Personal Trainer",
      "slug": "trainer"
    }
  ],
  "meta": {},
  "customFields": {},
  "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
    }
  ]
}

Request example

POST /api/v1/customer/create

post
curl -X POST "https://api.bizkithub.com/api/v1/customer/create?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "email": "jan@barasek.com",
  "companyName": "BizKitHub",
  "companyRegistrationNumber": "05103118",
  "taxIdentificationNumber": "CZ9609040727",
  "customerRealIp": "1.1.1.1"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key