Home › Account & Wallet

Register — FarazSMS SMS web service

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

Purpose: Register an account via the API (not needed just to send SMS).

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

• Account registration via API. Not needed for sending SMS.

Example body

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

Responses

• 200 — OK

Related endpoints in Account & Wallet

• GET /ws/v1/account/balance — Account Balance
• POST /ws/v1/account/wallet/charge — Charge wallet
• GET /ws/v1/account/profile — Profile
• POST /ws/v1/account/update — update
• GET /ws/v1/lines/accessible — Lines
• POST /ws/v1/orders/apply-discount — Apply Discount on Order
• POST /ws/v1/orders/cancel — Cancel an Order
• POST /ws/v1/orders/pay — Pay Created Order

All FarazSMS web services · llms.txt · OpenAPI