POST /api/customer/register HTTP/1.1
Host: <API_HOST>
Accept: application/json
Content-Type: application/json

{
  "firstName": "Asha",
  "lastName": "Kumar",
  "password": "<PASSWORD>",
  "emailId": "asha@example.com",
  "otp": 123456,
  "phoneNumber": "9876543210"
}

{
  "status": 1,
  "message": "Successfully Created Registration",
  "data": {
    "firstName": "Asha",
    "lastName": "Kumar",
    "emailId": "customer@example.com"
  }
}

{
  "status": 0,
  "message": "Please enter a valid OTP"
}

Customer login and sessions

Register a Store customer after OTP verification.

Authentication: Public; tenant validation applies.

Feature area: Authentication

Implementation source: src/api/store/controllers/CustomerController.ts

Request example provenance: Request fields are from CustomerRegisterRequest; success wrapper is from the handler, with PII-safe example values.

Response example provenance: Request fields are from CustomerRegisterRequest; success wrapper is from the handler, with PII-safe example values.

Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.

POST

api

customer

POST /api/customer/register HTTP/1.1
Host: <API_HOST>
Accept: application/json
Content-Type: application/json

{
  "firstName": "Asha",
  "lastName": "Kumar",
  "password": "<PASSWORD>",
  "emailId": "asha@example.com",
  "otp": 123456,
  "phoneNumber": "9876543210"
}

{
  "status": 1,
  "message": "Successfully Created Registration",
  "data": {
    "firstName": "Asha",
    "lastName": "Kumar",
    "emailId": "customer@example.com"
  }
}

{
  "status": 0,
  "message": "Please enter a valid OTP"
}

Body

application/json

Request body follows the current CustomerRegisterRequest DTO. Required fields and password constraints are taken from class-validator decorators.

firstName

string

required

Required. Customer first name.

Maximum string length: 32

password

string<password>

required

write-only

Required. At least 8 characters; must include uppercase and lowercase letters and a number or symbol.

Required string length: 8 - 128

emailId

string

required

Required. Customer email address.

Maximum string length: 96

otp

integer

required

Required. OTP sent to the email address.

lastName

string

Optional. Customer last name.

companyName

string

taxNumber

string

phoneNumber

string

Optional. Customer phone number.

Maximum string length: 15

Response

Successful response. Request fields are from CustomerRegisterRequest; success wrapper is from the handler, with PII-safe example values.

status

integer

message

string

data

object

Show child attributes

Store API

Vendor API

Register a Store customer after OTP verification.

Body

Response