---
title: "Profile"
method: GET
path: "/ws/v1/account/profile"
tags: ["Account"]
---

# Profile

`GET /ws/v1/account/profile`

## Request

- Base URL: `https://api.iranpayamak.com`
- URL: `https://api.iranpayamak.com/ws/v1/account/profile`
- Auth: API key in header `Api-Key`

The Login API allows users to authenticate by providing valid credentials like username and password. It typically returns an access token upon successful authentication.

## Response `200`

- object
  - `status` string, required
  - `message` object, required
  - `data` object, required
    - `displayName` string, required: User fullname or organiztion name
    - `mobile` string, required: Account owner mobile number
    - `verified` boolean, required: Account verification status
    - `blocked` boolean, required: Account suspention status
    - `plan` object, required: Account plan details like name, and expired date (if exists)
      - `id` integer, required
      - `title` string, required
      - `expiryDate` string
    - `permissions` string, required: Account permitions ans limitations

## Other responses

- `401`

---

[API](https://skmtc.dev/farazsms/apis/farazsms-public-apis.md) - [All operations](https://skmtc.dev/farazsms/apis/farazsms-public-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/farazsms/apis/farazsms-public-apis/revisions/e80a7c5dea3f?raw)