Skip to main content
POST

Query Parameters

​
expiresIn
enum<string>
default:30d

How long the issued token stays valid.

Available options:
1h,
1d,
7d,
30d,
180d,
1y

Body

application/json

Send exactly one of email or phone.

​
password
string
required
Maximum string length: 250
​
email
string<email>

Account email address. Required unless phone is sent.

​
phone
string

Iranian mobile number in the form 09XXXXXXXXX.

Pattern: ^09\d{9}$
Example:

"09120000000"

​
twoFAType
enum<string>

Which second factor you're sending. Required when two-factor authentication is enabled on the account.

Available options:
totp,
recoveryCode
​
totp
string

6-digit code from your authenticator app. Required when twoFAType is totp.

Required string length: 6
​
recoveryCode
string

One of your 10-character recovery codes. Required when twoFAType is recoveryCode.

Required string length: 10

Response

Logged in.

​
api_token
string

API token to send as Authorization: Bearer <api-token>.

​
fullname
string
​
avatar
string<uri>