Auth

Check invitation status and user existence

Check if an invitation token is valid and whether it's for an existing user or new user. This helps determine whether to show login or register flow in the frontend.

post/api/v1/auth/invitation/check-status

Request

  • Base URL: https://api-sandbox.koywe.com
  • URL: https://api-sandbox.koywe.com/api/v1/auth/invitation/check-status
  • Auth: none declared

Request body

tokenstring required

The unique invitation token to check

Example request

{
  "token": "7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b"
}

Response

Invitation status checked successfully.

isExistingUserboolean required

Whether the invitation is for an existing user (true) or new user (false)

emailstring required

Email address associated with the invitation

invitationType'MERCHANT' | 'ORGANIZATION' required

Type of invitation: MERCHANT or ORGANIZATION

Example response

{
  "isExistingUser": true,
  "email": "user@example.com",
  "invitationType": "MERCHANT"
}

Changes

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