Registration

Registration flows with loyalty support

Register user with optional loyalty enrollment

post

Creates a user account and optionally enrolls loyalty. Phone must be unique when PHONE_NUMBER_UNIQUE_VALIDATOR_ACTIVE is enabled. Loyalty behavior is driven by CUSTOMER_LOYALTY_CARD_SERVICE.

Throttling scope: register-with-loyalty. Two-factor: SMS verification via code/resend.

Body

application/json

Responses

201

Registration succeeded

202

Verification code sent

400

Validation error

post

/users/register-with-loyalty/

HTTPcURLJavaScriptPython

POST /users/register-with-loyalty/ HTTP/1.1
Host: sandbox.akinon.com
Content-Type: application/json
Accept: */*
Content-Length: 375

{
  "first_name": "text",
  "last_name": "text",
  "email": "[email protected]",
  "password": "password",
  "email_allowed": false,
  "sms_allowed": false,
  "whatsapp_allowed": false,
  "call_allowed": null,
  "confirm": true,
  "code": null,
  "resend": false,
  "gender": "male",
  "date_of_birth": null,
  "username": null,
  "user_type": "text",
  "phone": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "add_loyalty": false
}

No content

Register user

post

Creates a user account. When GUEST_USER_REGISTRATION_REQUIRES_EMAIL_VERIFICATION is enabled, login is blocked until email is verified.

The registration flow is selected via REST_REGISTER_VIEW (System Configuration):

• RegisterSMSOtpView: Requires phone + SMS code (2FA).

• RegisterKvkkView: Requires consent fields; may request SMS code.

• UserRegisterWithLoyaltyCardViewSet: Supports loyalty enrollment; phone verification via SMS.

• RegisterRedirectView: Default email-first flow.

2FA coverage:

• SMS-based second factor is enforced when RegisterSMSOtpView is active.

• Loyalty registration enforces SMS verification for phone changes and enrollment.

• When RegisterSMSOtpView is configured, this endpoint requires phone plus SMS code/resend values for completion.

Throttling scope: register.

Body

application/json

first_namestring · max: 50Required

last_namestring · max: 50Required

emailstring · emailRequired

passwordstring · passwordRequired

email_allowedbooleanOptionalDefault: false

sms_allowedbooleanOptionalDefault: false

whatsapp_allowedbooleanOptionalDefault: false

call_allowedboolean | nullOptional

confirmbooleanRequired

Confirms acceptance of policies

codestring | nullOptional

SMS verification code (used in SMS OTP/KVKK flows)

resendboolean | nullOptional

Request a new SMS verification code (SMS OTP/KVKK flows)

Default: false

genderstring,null · enumOptionalPossible values:

date_of_birthstring | nullOptional

usernamestring | null · max: 150Optional

user_typestringOptional

User type enumeration value

phonestring | nullOptional

Responses

201

Registration succeeded

400

Validation error

post

/users/registration/

HTTPcURLJavaScriptPython

POST /users/registration/ HTTP/1.1
Host: sandbox.akinon.com
Content-Type: application/json
Accept: */*
Content-Length: 247

{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "[email protected]",
  "password": "StrongPass!234",
  "confirm": true,
  "email_allowed": true,
  "sms_allowed": false,
  "whatsapp_allowed": false,
  "call_allowed": false,
  "gender": "female",
  "date_of_birth": "1990-01-15"
}

Default registration (email-first)SMS 2FA registration (RegisterSMSOtpView / RegisterKvkkView)

No content

Confirm email

get

Path parameters

keystringRequired

Email confirmation key

Responses

302

Email confirmed and redirected

400

Invalid or expired key

get

/users/registration/account-confirm-email/{key}/

HTTPcURLJavaScriptPython

GET /users/registration/account-confirm-email/{key}/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

No content