---
title: "Get the invitation link for a shareholder invitation"
method: POST
path: "/api/v1/merchants/{merchantId}/shareholder-invitations/{id}/link"
tags: ["Shareholder Invitations"]
---

# Get the invitation link for a shareholder invitation

`POST /api/v1/merchants/{merchantId}/shareholder-invitations/{id}/link`

Get the invitation link for a shareholder invitation

## Path parameters

- `merchantId` string, uuid, required
- `id` string, uuid, required

## Response `200`

Success

- ShareholderInvitationWithLinkResponse — Response containing a shareholder invitation with link
  - `success` boolean, required — Indicates if the request was successful
  - `data` object, required — Shareholder invitation with onboarding link
    - `id` string, uuid, required — Shareholder invitation ID
    - `email` string, email, required — Invitee email address
    - `merchant_id` string, uuid, required — Merchant this invitation belongs to
    - `shareholder_type` string, nullable, required — Type of shareholder (individual)
    - `shareholder_country_iso2` string, nullable, required — Country ISO2 code set during onboarding
    - `status` union, required — Current status of the invitation
      - 'pending'
      - 'accepted'
    - `expires_at` string, date-time, required — When this invitation expires
    - `accepted_at` string, date-time, nullable, required — When the invitation was accepted
    - `opened_at` string, date-time, nullable, required — When the invitation link was first opened
    - `current_step` number, required — Current wizard step (0-3)
    - `current_step_name` string, required — Name of the current step (consent, basic_info, address, or complete)
    - `steps_completed` number[], required — Array of completed step numbers
    - `core_shareholder_id` string, uuid, nullable, required — ID of the shareholder created in Core (set after step 1)
    - `invited_by_user_id` string, uuid, nullable, required — User ID of the person who created this invitation
    - `created_at` string, date-time, required — When the invitation was created
    - `display_status` union, required — Computed display status for UI
      - 'accepted'
      - 'filling_details'
      - 'invite_created'
      - 'invite_sent'
    - `total_steps` number, required — Total number of wizard steps
    - `invitation_link` string, required — Invitation link for the shareholder to complete onboarding
    - `email_sent` boolean — Whether the invitation email was successfully sent

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found

---

[API](https://skmtc.net/banqzinc/apis/quidkey-api.md) · [All operations](https://skmtc.net/banqzinc/apis/quidkey-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/banqzinc/quidkey-api/revisions/f86d2bdbcb08/schema)