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

SMS Login

Developing

POST

{store_url}/api/v1/auth/sms

Initiates authentication using a mobile number and sends a verification code through SMS.

Depending on whether the mobile number is associated with an existing customer, the response may indicate that the customer can continue the login process or that registration is required. The endpoint may also return information about the customer, cart session, and abandoned-cart merging status.

Request

Body Params application/x-www-form-urlencodedRequired

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --globoff '{store_url}/api/v1/auth/sms' \
--data-urlencode 'mobile_number=501234567' \
--data-urlencode 'country_code=+966' \
--data-urlencode 'resend=false'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "detail": [
        {
            "loc": [
                "string",
                0
            ],
            "msg": "string",
            "type": "string",
            "input": "string",
            "ctx": {}
        }
    ]
}

🟠422Validation Error

Modified at 2026-06-21 10:29:46

Verify SMS Login