v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Shareholder Invitations

Create a shareholder invitation for KYC onboarding

Create a shareholder invitation for KYC onboarding

post/api/v1/merchants/{merchantId}/shareholder-invitations

Path parameters

merchantIdstring uuid required

The merchantId parameter

Request body

emailstring email required

Email address of the shareholder to invite

send_emailboolean

Whether to email the invitation now. Defaults to true when omitted.

Response

Created

successboolean required

Indicates if the request was successful

Example response

{
  "success": true
}