Skip to content
BookendBookend Docs

Redeem an emailed link token

POST
/v1/auth/otp/redeem
curl --request POST \
  --url http://localhost:8080/v1/auth/otp/redeem \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example" }'

Anonymous. Exchanges the token from an emailed sign-in, password-reset or invite link for an access token and refresh token. The token is single-use. 401 when it is unknown, expired, already redeemed or the user is inactive.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
token
string
Examplegenerated
{
  "token": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

Access token (15 min default) + rotating refresh token, returned in the body and held in memory by the SPA.

object
accessToken
required
string
accessExpiresAt
required
string format: date-time
refreshToken
required
string
refreshExpiresAt
required
string format: date-time
user
required
object
id
required
string format: uuid
email
required
string
displayName
required
string
roles
required
Array<string>
isActive
required
boolean
lastLoginAt
required
null | string format: date-time
totpEnrolled
required
boolean
Examplegenerated
{
  "accessToken": "example",
  "accessExpiresAt": "2026-04-15T12:00:00Z",
  "refreshToken": "example",
  "refreshExpiresAt": "2026-04-15T12:00:00Z",
  "user": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "email": "example",
    "displayName": "example",
    "roles": [
      "example"
    ],
    "isActive": true,
    "lastLoginAt": "2026-04-15T12:00:00Z",
    "totpEnrolled": true
  }
}