Invitation

Accept invitation

Public endpoint for any user to accept their invitation. No authentication required. The invitation token (from the email link) identifies the user. Password is optional: when provided (seed scripts), the backend sets it directly; when omitted (browser flow), the user sets their password on first login via Cognito challenge.

post/api/v1/invitations/accept

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api/v1/invitations/accept
  • Auth: HTTP bearer

Request body

tokenstring required

The unique invitation token from the email link

passwordstring

Optional password for headless acceptance (CLI/seed). When provided and allow-headless-password is enabled, the server sets this password directly instead of returning a challenge session. Omit for browser-based acceptance.

Example request

{
  "token": "abc123xyz456"
}

Response

Invitation accepted successfully

Changes

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