Sign in

v45

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-2684278289.5 KB
Recipient Invites

Get recipient invite by ID

Retrieve details of a specific recipient invite by ID.

get/recipients/invites/{inviteId}

Path parameters

inviteIdstring required

ID for the invite

Response

contactEmailstring required

Recipient contact email the invite was created for.

createdAtstring yyyy-mm-ddThh:MM:ssZ required

When the invite was created.

expiresAtstring yyyy-mm-ddThh:MM:ssZ nullable

When the invite expires, if it has an expiry.

idstring required

The invite's id, also embedded in 'onboardingUrl'.

namestring required

Recipient name the invite was created for.

notesstring nullable

Notes shown to the recipient, if any.

onboardingUrlstring required

URL where the recipient submits their payment details.

paymentMethodsPaymentMethod[] required

Payment methods the recipient may submit details for.

recipientIdstring uuid nullable

The existing recipient this invite is for, if any.

requireTaxDocumentboolean required

Whether the recipient must upload a tax document.

status'created' | 'completed' | 'expired' required

Status of the invite.

Example response

{
  "createdAt": "2016-07-22T00:00:00Z",
  "expiresAt": "2016-07-22T00:00:00Z"
}