Skip to main content
POST
Register customer account

Authorizations

Authorization
string
header
required

API Key Authentication

Use your API key in the Authorization header:

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

password
string
required

Password (minimum 8 characters)

Minimum string length: 8
Example:

"SecurePassword123!"

name
string

Customer full name

Example:

"John Doe"

phone
string

Phone number with country code

Example:

"+12125550142"

Whether the customer opted in to marketing communications at sign-up. Defaults to false (opt-in). Pass the state of your sign-up form's marketing opt-in checkbox.

Example:

true

Response

Registration successful

message
string

Success message

Example:

"Registration successful"

user
object
customer
object
session
object
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