---
title: "Given an invitation URL, get its type (admin or regular account member) and find whether it is correctly formed and is enabled or disabled."
method: POST
path: "/invite/check"
tags: ["registration", "default"]
---

# Given an invitation URL, get its type (admin or regular account member) and find whether it is correctly formed and is enabled or disabled.

`POST /invite/check`

## Request

- Base URL: `{{ server_url }}/v1`
- URL: `{{ server_url }}/v1/invite/check`
- Auth: none declared
- TypeScript: <https://skmtc.dev/athenian/apis/title/docs/invite/check/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- InvitationLink: Product invitation URL.
  - `url` string, url, required: Invitation URL. Users are supposed to click it and become admins or regular account members.

## Response `200`

Result of checking an invitation URL: invitation type, whether it is correctly formed and is enabled.

- InvitationCheckResult
  - `active` boolean: Value indicating whether the invitation is still enabled.
  - `type` 'admin' | 'regular': Invited user's account membership status.
  - `valid` boolean, required: Value indicating whether the invitation URL is correctly formed.

---

[API](https://skmtc.dev/athenian/apis/title.md) - [All operations](https://skmtc.dev/athenian/apis/title/llms.txt) - [OpenAPI document](https://skmtc.dev/athenian/apis/title/revisions/110c9f7cffdd?raw)