---
title: "Get recipient invite by ID"
method: GET
path: "/recipients/invites/{inviteId}"
tags: ["Recipient Invites"]
---

# Get recipient invite by ID

`GET /recipients/invites/{inviteId}`

Retrieve details of a specific recipient invite by ID.

## Path parameters

- `inviteId` string, required — ID for the invite

## Response `200`

- RecipientInviteApiResponse
  - `contactEmail` string, required — Recipient contact email the invite was created for.
  - `createdAt` string, yyyy-mm-ddThh:MM:ssZ, required — When the invite was created.
  - `expiresAt` string, yyyy-mm-ddThh:MM:ssZ, nullable — When the invite expires, if it has an expiry.
  - `id` string, required — The invite's id, also embedded in 'onboardingUrl'.
  - `name` string, required — Recipient name the invite was created for.
  - `notes` string, nullable — Notes shown to the recipient, if any.
  - `onboardingUrl` string, required — URL where the recipient submits their payment details.
  - `paymentMethods` PaymentMethod[], required — Payment methods the recipient may submit details for.
  - `recipientId` string, uuid, nullable — The existing recipient this invite is for, if any.
  - `requireTaxDocument` boolean, required — Whether the recipient must upload a tax document.
  - `status` 'created' | 'completed' | 'expired', required — Status of the invite.

## Other responses

- `404` — `inviteId` not found

---

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