Invites

High-level description

Invite content directs the recipient to an HTTPS URL for a time-limited action. Use the common payload below for every invite, then provide an invite object that matches the selected subtype.

Sub-types

Type	Description	Retained delivery
`invite.research`	Invitation to participate in a survey or poll.	Not supported
`invite.gift`	Invitation to collect a gift.	Not supported
`invite.sign`	Invitation to sign a document with an external signing service.	Supported
`invite.voucher`	Invitation to use a voucher.	Not supported
`invite.kyc`	Invitation to complete a Know Your Customer (KYC) process.	Not supported

Common payload

Every invite request needs a recipient identifier, subject, type, and usually one or more PDF parts. The invite object is required for all invite.* types, but its shape depends on the selected subtype.

Field	Purpose
`ssn`, `email`, or `vat_number`	Identifies the person or company recipient
`subject`	Short inbox title; never include personal or sensitive information
`type`	Selects the invite subtype
`parts`	Contains the invitation as a PDF
`generated_at`	Optional timestamp used for inbox sorting
`invite`	Supplies subtype-specific URL, expiry, and organisation metadata
`retain` and `retention_time`	Enables retained delivery only for `invite.sign`

{
  "ssn": "YYYYMMDDNNNN",
  "subject": "Complete your profile",
  "type": "invite.research",
  "parts": [
    {
      "name": "research-invitation.pdf",
      "content_type": "application/pdf",
      "data": "BASE64_ENCODED_PDF"
    }
  ],
  "invite": {
    "title": "Help improve our service",
    "description": "Answer a short survey about your experience.",
    "uri": "https://example.com/research",
    "behalf_of": {
      "name": "Example AB",
      "vat_number": "SE556840226601"
    },
    "expires_at": "2026-10-01T23:59:59Z"
  }
}

Other information

Only invite.sign supports retained delivery. See Retained content for the retain-or-deliver flow and supported retention periods.

See the Send content API reference for subtype-specific URL, expiry, and organisation fields.