Docs API Reference Customer/api/v1/customer/register-account

postCustomerPublic API v1

/api/v1/customer/register-account

Registers a new customer account with email and password. Sends a verification email. Returns error codes on validation failure.

List of error codes:

Code	Message
E001	Customer register failed.
E002	Customer has been registered.
E003	Customer account has been banned.
E004	Too many registration attempts.

customerpostApiV1CustomerRegister-account

Parameters

1 query · 21 body

22 total

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

Body · 21

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.

namestring

firstNamestring

lastNamestring

phonestring

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).

companyNamestring

companyRegistrationNumberstring

taxIdentificationNumberstring

streetAddressstring

citystring

cityPartstring

stateRegionstring

postalCodestring

countrystring

newsletterboolean

Default: false

primaryLocalestring

groupsstring[]

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

referralIdstring

cuRefNo = customer reference number.

Length: 16–16

passwordstringRequired

Length: 1–∞

returnUrlstring

Request

POST /api/v1/customer/register-account

post

curl -X POST "https://api.bizkithub.com/api/v1/customer/register-account?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "email": "jan@barasek.com",
  "name": "Jan Barášek",
  "firstName": "Jan",
  "lastName": "Barášek",
  "phone": "+420 777123456",
  "companyName": "BizKitHub",
  "companyRegistrationNumber": "05103118",
  "taxIdentificationNumber": "CZ9609040727",
  "streetAddress": "R. Novotného 1505",
  "city": "Kladno",
  "cityPart": "Kročehlavy",
  "stateRegion": "Středočeský kraj",
  "postalCode": "272 01",
  "country": "CZ",
  "newsletter": false,
  "primaryLocale": "cs",
  "groups": [
    "string"
  ],
  "customerRealIp": "1.1.1.1",
  "referralId": "1cGIHvFoQDGLAbcA",
  "password": "example_password",
  "returnUrl": "example_returnUrl"
}'

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key