> ## Documentation Index
> Fetch the complete documentation index at: https://ekacare-mintlify-80308f89.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Invite flow

## Overview

The **Invite Flow** allows workspace admins to onboard users into thier workspace using an invite link generated from the **Eka Developer Console**.

## Creating an Invite Link

<Steps>
  <Step title="Open the Eka Developer Console">
    <a href="https://console.eka.care" target="_blank">Click here to visit Eka Developer Console</a>.

    <Note>
      You must be an Admin to create invites.
    </Note>
  </Step>

  <Step title="Navigate to Invites">
    From the left sidebar, click on <strong>Invites</strong>.

    <img src="https://mintcdn.com/ekacare-mintlify-80308f89/AddPEjxaeC_E-a2e/api-reference/authorization/images/invite-flow/invite-left-side-panel.png?fit=max&auto=format&n=AddPEjxaeC_E-a2e&q=85&s=4a686ab6a8a16eea85ec5e9a12f2e0c2" alt="Developer Console with Invites highlighted" data-zoomable width="1280" height="800" data-path="api-reference/authorization/images/invite-flow/invite-left-side-panel.png" />
  </Step>

  <Step title="Create Invite Link">
    Click on <strong>Create Invite Link</strong>. Once created, an invite link is generated.

    <img src="https://mintcdn.com/ekacare-mintlify-80308f89/AddPEjxaeC_E-a2e/api-reference/authorization/images/invite-flow/create-invite.png?fit=max&auto=format&n=AddPEjxaeC_E-a2e&q=85&s=38acb6d57214f11ae11ece623c62752e" alt="Developer Console with Invites highlighted" data-zoomable width="1148" height="593" data-path="api-reference/authorization/images/invite-flow/create-invite.png" />

    <img src="https://mintcdn.com/ekacare-mintlify-80308f89/AddPEjxaeC_E-a2e/api-reference/authorization/images/invite-flow/copy-invite-link.png?fit=max&auto=format&n=AddPEjxaeC_E-a2e&q=85&s=c59895ced0fc39ace6894c942e81bcbd" alt="Developer Console with Invites highlighted" data-zoomable width="656" height="447" data-path="api-reference/authorization/images/invite-flow/copy-invite-link.png" />

    <Note>
      Copy the link before leaving the page as it will not be shown again.
    </Note>

    <Note>
      Invite links grant access to a specific product and workspace.
      Do <strong>not</strong> share an invite link with anyone other than the intended recipient.
    </Note>
  </Step>
</Steps>

***

## Consuming an Invite Link

Once generated, the invite link can be shared with the user via email, chat, or any external channel.

Once an invite link is created and shared, the invited user can join the workspace by opening the link.
The system ensures the user is authenticated before granting workspace access.

***

## Invite Authentication Flow

<Steps>
  <Step title="Open the Invite Link">
    The user clicks the invite link shared with them and the user is redirected to the authentication flow.
  </Step>

  <Step title="Choose Sign-Up or Login Method">
    On the authentication screen, the user can choose their preferred method to continue.

    Eka supports multiple options such as:

    * Google
    * Apple
    * Email Address
    * Username

    In this guide, we’ll walk through the flow using <strong>Email Address</strong>.

    <img src="https://mintcdn.com/ekacare-mintlify-80308f89/AddPEjxaeC_E-a2e/api-reference/authorization/images/eka-sign-up-options.png?fit=max&auto=format&n=AddPEjxaeC_E-a2e&q=85&s=330434f20b64f39ef4d8069fac37e043" alt="Eka sign-up options screen" width="1024" height="1024" data-path="api-reference/authorization/images/eka-sign-up-options.png" />
  </Step>

  <Step title="Enter Email Address">
    The user enters their email address and clicks <strong>Submit</strong>.

    <img src="https://mintcdn.com/ekacare-mintlify-80308f89/AddPEjxaeC_E-a2e/api-reference/authorization/images/enter-email.png?fit=max&auto=format&n=AddPEjxaeC_E-a2e&q=85&s=e295140fe48bbec2ab2640bcadea284d" alt="Eka enter email" width="552" height="578" data-path="api-reference/authorization/images/enter-email.png" />
  </Step>

  <Step title="Verify Email Using OTP">
    A one-time password (OTP) is sent to the user’s email address.

    The user enters the OTP and clicks <strong>Confirm</strong> to continue authentication.

    <img src="https://mintcdn.com/ekacare-mintlify-80308f89/AddPEjxaeC_E-a2e/api-reference/authorization/images/verify-otp.png?fit=max&auto=format&n=AddPEjxaeC_E-a2e&q=85&s=00ca9e67dcc614672d97bbaa4c56986c" alt="OTP verification screen" data-zoomable width="684" height="489" data-path="api-reference/authorization/images/verify-otp.png" />
  </Step>

  <Step title="Set Up Profile Details (New Users Only)">
    Users are prompted to set up their profile.

    <img src="https://mintcdn.com/ekacare-mintlify-80308f89/AddPEjxaeC_E-a2e/api-reference/authorization/images/invite-flow/setup-profile.png?fit=max&auto=format&n=AddPEjxaeC_E-a2e&q=85&s=cbc99051513c45403f98d1d77649d940" alt="OTP verification screen" data-zoomable width="1024" height="1024" data-path="api-reference/authorization/images/invite-flow/setup-profile.png" />

    After entering the profile details, click <strong>Next</strong> to continue.
  </Step>

  <Step title="Invite Validation and Consumption">
    After successful authentication and profile setup, invite is consumed and workspace access is granted to the user.
  </Step>

  <Step title="Redirect to Product">
    Once the invite is successfully consumed, the user is redirected automatically.

    The redirection is based on the invite configuration and includes:

    * The <strong>target product</strong> (for example, EMR)
    * The <strong>specific workspace</strong> for which the invite was created

    This ensures the user lands directly in the correct product context
    without requiring any additional product selection.
  </Step>
</Steps>