Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

Register

Developing

POST

{store_url}/api/v1/auth/register

Creates a new customer account using the selected registration channel. Depending on the register_type, the verification code is sent through SMS, email, or WhatsApp.

Request

Query Params

Body Params application/jsonRequired

Example

{
    "name": "Ahmed Ali",
    "email": "customer@example.com",
    "country_code": "+966",
    "mobile_number": "501234567",
    "is_newsletter_subscriber": false
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --globoff '{store_url}/api/v1/auth/register?register_type=sms' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Ahmed Ali",
    "email": "customer@example.com",
    "country_code": "+966",
    "mobile_number": "501234567",
    "is_newsletter_subscriber": false
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "login_type": "signup",
    "status": "registration_success_verification_sent",
    "channel": "sms",
    "mobile": "+966501234567",
    "customer_id": 12345,
    "email_hidden": "c******r@example.com",
    "property1": {},
    "property2": {}
}

🟠422

Modified at 2026-06-21 10:57:43

Verify Email Login