Skip to main content
POST
Create an invite

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
name
string
required

The name of the person being invited.

Maximum string length: 100
Example:

"John Doe"

email
string
required

The email of the person being invited.

Maximum string length: 100
Example:

"example@example.com"

phoneNumber
string

The phone number of the person being invited.

Maximum string length: 15
Example:

"2232322323"

reference
string

The invite reference.

Maximum string length: 100
Example:

"Reference 123"

identity
object

The identity object containing data about the business and its representatives

payoutBankAccounts
object[]

Bank accounts where the merchant receives payouts.

feesTemplateId
string

UUID of the fees template with predefined fees. If no value is passed, the id of the default template will be used.

Example:

""

fees
object

The fees object will overwrite the values set on the fees template, as specified by the feesTemplateId. This allows for customization of fees at the invite overriding any defaults defined in the template.

onboardingFlowTemplateId
string

UUID of the onboarding flow template to be used for the onboarding experience.

Example:

""

Response

Onboarding invite successfully created.

success
boolean

Whether the request was processed successfully. Declines return HTTP 200 with success: false.

code
string

Machine-readable result code. See the Error Codes reference.

message
string

Human-readable result message.

data
object

The response payload.

Last modified on July 14, 2026