Skip to content

Register a shopper

POST
/api/v1/customer/auth/register/

Create a shopper account for your store. Returns a token pair plus the customer profile. A 6-digit email verification code is sent automatically (verify it with the OTP endpoints).

Authorizations

apiKey

Your business API key (sb_live_*) — identifies which store the request is for. Required on every /api/v1/business/website/ request.

Type
API Key (header: X-Periscale-Key)

Request Body

application/json
JSON
{
  
"email": "string",
  
"password": "string",
  
"password_confirm": "string",
  
"first_name": "string",
  
"last_name": "string",
  
"phone": "string"
}

Responses

Account created; tokens issued.

application/json
JSON
{
  
"status": true,
  
"status_code": 0,
  
"message": "string",
  
"data": {
  
  
"access_token": "string",
  
  
"refresh_token": "string",
  
  
"access_expires_at": "string",
  
  
"refresh_expires_at": "string",
  
  
"token_type": "Bearer",
  
  
"customer": "string"
  
}
}

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI

© Periscale