Register customer account

Create a new customer account with email and password. Returns user details and authentication tokens upon successful registration.

Multi-Store Support:

• If the email is already registered at another store, a new customer record is created for this store (linked to the existing auth.users record)
• Response includes is_multi_store_customer: true when linking to existing account
• Customers can have accounts at multiple stores with the same email/password

⚠️ SECRET KEY REQUIRED

This endpoint requires a secret key (tybrite_sk_*). Publishable keys will return 403 Forbidden.

Why Secret Key? Authentication endpoints create and manage user sessions, which should only be performed from secure server-side environments.

POST /v1/auth/register

Register customer account

cURL

curl --request POST \
  --url https://api.tybritelabs.com/v1/auth/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[e-mail]",
  "password": "SecurePassword123!",
  "name": "Jane Doe",
  "phone": "[phone]"
}
'

201

{
  "message": "Registration successful",
  "user": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "[e-mail]",
    "email_confirmed": true,
    "created_at": "2023-11-07T05:31:56Z"
  },
  "customer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "email": "[e-mail]",
    "phone": "<string>",
    "address": "<string>",
    "join_date": "2023-12-25",
    "total_purchases": 123,
    "last_purchase": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "store_metrics": {
      "total_purchases": 123,
      "total_spent": 123,
      "first_purchase_date": "<string>",
      "last_purchase_date": "<string>",
      "status": "<string>",
      "preferred_store": "<string>"
    }
  },
  "session": {
    "access_token": "<string>",
    "refresh_token": "<string>",
    "expires_in": 123,
    "expires_at": 123
  },
  "is_multi_store_customer": false
}

Authorizations

Authorization · string · header · required

API Key Authentication

Use your API key in the Authorization header:

Authorization: Bearer tybrite_sk_live_YOUR_KEY

Key Types:

Secret Keys (Server-Side Only):

• Format: tybrite_sk_live_* (production) or tybrite_sk_test_* (sandbox)
• Full read/write access to all endpoints
• ⚠️ NEVER expose in client-side code or public repositories
• Required for: write operations, authentication, payment verification, AI recommendations

Publishable Keys (Client-Safe):

• Format: tybrite_pk_live_* (production) or tybrite_pk_test_* (sandbox)
• Read-only access (GET requests only, plus POST semantic search)
• ✅ Safe for client-side JavaScript, mobile apps, and public code
• Allowed for: browsing products, search, CMS content, pricing queries

Endpoint-Specific Requirements:

• Authentication endpoints (/v1/auth/*): Secret key required
• Payment verification (POST /v1/payments/verify): Secret key required
• AI Recommendations (POST /v1/recommendations): Secret key required
• Semantic Search (POST /v1/search): Both key types allowed (read-only operation)
• All write operations: Secret key required
• All read operations: Both key types allowed

Using a publishable key for restricted operations returns 403 Forbidden.

Body

application/json

email · string<email> · required

Customer email address

Example:

"[e-mail]"

password · string · required

Password (minimum 8 characters)

Minimum string length: 8

Example:

"SecurePassword123!"

name · string

Customer full name

Example:

"Jane Doe"

phone · string

Phone number with country code

Example:

"[phone]"

Response

201

application/json

Registration successful

message · string

Success message

Example:

"Registration successful"

user · object

Show child attributes

customer · object

Show child attributes

session · object

Show child attributes

is_multi_store_customer · boolean

Indicates if this customer already had an account at another store. When true, the customer's auth.users record already existed, and a new customers record was created for this store. When false or omitted, this is the customer's first store registration.

Example:

false