Account Information10

Admin13

Agreement2

Auth4

Bank Predictions1

Banks9

Branding14

Command Palette2

Countries3

CrossBorder5

Customer Bank Accounts4

Customers3

Dashboard1

Default Rates3

Embedded8

Evidence1

Go Live2

Invoice10

Legal1

Legal Entities11

Merchant Bank Account Payment Schemes1

Merchant Bank Accounts6

Merchant Documents2

Merchant Invitations4

Merchant Rates3

Merchants16

Onboarding3

Partner Invitations4

Partners6

Payment1

Payment Links6

Payment Schemes1

Payments8

Payout6

Post-Processor Logs2

Provider Configuration4

Refund Resolution Links4

Refunds1

Seeds2

Shareholder Documents2

Shareholder Invitations7

Shopify Orders3

Transaction Updates (Token)3

Transactions14

User Invitations2

Users10

Webhook3

Webhooks5

Shareholder Invitations

Preview a shareholder invitation (public, no auth required)

get/api/v1/shareholder-invitations/preview

Query parameters

tokenstring required

Raw invitation token

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true
}

Changes

Changed in 2 of the 8 revisions of this API.11

Jun 16, 2026b372e7d5563d1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 2, 2025919eb7a392aa1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 367 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history