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

WhatsApp Login

Developing

POST

{store_url}/api/v1/auth/whatsapp

Initiates authentication using a mobile number and sends a verification code through WhatsApp. The response indicates whether the customer should continue with login or complete the registration process.

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/whatsapp' \
--data-urlencode 'mobile_number=501234567' \
--data-urlencode 'country_code=+966' \
--data-urlencode 'resend=false'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "login_type": "signup",
    "status": "registration_needed",
    "channel": "whatsapp",
    "mobile_number": "501234567",
    "country_code": "+966",
    "email": "customer@example.com",
    "mobile": "+966501234567",
    "email_exists": true,
    "sent_at": "2026-06-21T10:30:00Z",
    "cart_session_id": "cart_session_8f7c2a91",
    "is_active_abandoned_cart_merged": true,
    "customer_id": 12345,
    "has_addresses": true,
    "property1": {},
    "property2": {}
}

🟠422

Modified at 2026-06-21 10:42:32

Verify SMS Login

Verify WhatsApp Login