Endpoints

Create a token.

This endpoint lets you create a permanent token. When the account has two-factor authentication enabled and the client sends two_factor_supported: true, it returns 409 with a challenge to exchange at POST /api/v1/sanctum/token/two-factor.

post/api/v1/sanctum/token

Request

  • Base URL: https://hidemail.app
  • URL: https://hidemail.app/api/v1/sanctum/token
  • Auth: none required

Request body

emailstring required

Email.

passwordstring required

Password.

device_namestring required

Device Name.

two_factor_supportedboolean

Declares that the client can complete a two-factor challenge. Defaults to false.

Example request

{
  "email": "hi@example.com",
  "password": "password",
  "device_name": "Raycast",
  "two_factor_supported": true
}

Response

OR

Example response

{
  "token": "1a2b3c..."
}

Changes

No recorded changes to this operation across all 1 revision of this API.