Invite Representative Or Beneficial Owner
POST/api/partner/v1/onboarding/:ref/invitations
Invite a second person - a company representative or a beneficial owner - to complete the personal steps that cannot be done through the API. The person is identified only by first_name, last_name, email and phone (a 9-digit Polish mobile number, no country prefix); no account or login is created for them.
Only multi-person companies can invite people - individuals and sole traders return 422. Inviting a proxy representative (someone without their own signing rights) requires a power of attorney uploaded earlier via the documents endpoint, referenced here by power_of_attorney_document_id; the document must belong to this onboarding and be of the power-of-attorney type.
Supplying external_ref makes the call idempotent: repeating it with the same value for the same merchant returns the existing invitation with 200 and does not send a second e-mail/SMS. A brand-new invitation returns 201. The response carries the invitation's invitation_id (use it for resend/cancel) and its bearer-free hosted_url (the link the invited person opens). Responses never contain the invited person's personal data.
Requires scope onboarding:write.
Request
Responses
- 200
- 201
- 401
- 403
- 404
- 409
- 422
Existing invitation returned - idempotent match on external_ref. No new e-mail or SMS was sent.
Invitation created; the e-mail and SMS with the hosted link have been dispatched.
Missing or invalid partner bearer key.
The partner key lacks the onboarding:write scope.
No onboarding with this ref exists in one of your channels.
Onboarding is already completed - its data can no longer be edited.
Validation failed, the merchant is not a multi-person company, or a proxy representative is missing its power of attorney (power_of_attorney_document_id).