Home › Panel Login & Account

Register — FarazSMS SMS web service

POST https://api.iranpayamak.com/ws/v1/auth/register

Purpose: Registers a panel user; not needed to use the APIs.

Authentication

This endpoint requires the Api-Key header — get the key from the FarazSMS panel. The header name is case-sensitive and the key must never travel in a query string.

Request fields

• plan_id (integer) — required
• person_type (string) — required
• username (string) — required
• first_name (string) — required
• last_name (string) — required
• national_code (string) — required
• mobile (string) — required
• discount_code (string) — required
• seller_id (integer) — required
• should_notify_user (boolean) — required
• redirect_url (string) — required

Notes for this endpoint

• Panel user registration. Not required for the web services.

Example body

{
  "plan_id": 3,
  "person_type": "personal",
  "username": "test_name2",
  "first_name": "test fname",
  "last_name": "test lname",
  "national_code": "1234567890",
  "mobile": "09121234567",
  "discount_code": "",
  "seller_id": 1,
  "should_notify_user": true,
  "redirect_url": "https://api.iranpayamak.com"
}

Responses

• 200 — Success

Related endpoints in Panel Login & Account

• POST /ws/v1/auth/login — Login
• POST /ws/v1/auth/logout — Logout
• GET /ws/v1/auth/show_register_form — Show Register Form
• POST /ws/v1/auth/verify-2fa — Verify 2fa

All FarazSMS web services · llms.txt · OpenAPI