API Reference
Jupico WebsiteSupport

Create and send an invite

post
https://sandbox-platform.jupico.com/v1/onboardinginvites/createandsend

Create and immediately send an onboarding invite.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The name of the person being invited.

string
required

The email of the person being invited.

string

The phone number of the person being invited.

string

The invite reference.

identity
object

The identity object containing data about the business and its representatives

payoutBankAccounts
array of objects
payoutBankAccounts
string

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

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.

string

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

Responses

400

Bad Request. Invalid input.

401

Unauthorized.

500

Internal Server Error.

Updated 8 days ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 days ago