Skip to main content

InviteResponse

Invite details

inviteIduuid

Unique identifier of the invite

maskedEmailstring

Masked email address of the invited user

fullNamestring

Full name of the invited user

rolestring

Role assigned to the invited user

Possible values: [OWNER, ADMIN, EXECUTOR, PREPARER, VIEWER]

inviteUrlstring

URL the invited user should visit to accept the invite

expiresAtdate-time

When the invite expires. Invite links expire 14 days after creation.

statusstring

Current status of the invite.

  • PENDING — Invite has been created and is waiting for the user to accept.
  • COMPLETED — Invite has been accepted and the user has been linked to the account.
  • REVOKED — Invite was revoked because a new invite was issued via resend.
  • EXPIRED — Invite has passed its 14-day expiry window and can no longer be used.
  • LOCKED — Invite is locked due to too many failed email verification attempts.

Possible values: [PENDING, COMPLETED, REVOKED, EXPIRED, LOCKED]

InviteResponse
{
  "inviteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "maskedEmail": "string",
  "fullName": "string",
  "role": "OWNER",
  "inviteUrl": "string",
  "expiresAt": "2024-07-29T15:51:28.071Z",
  "status": "PENDING"
}