OnboardingInviteRequest

Request to create an onboarding invite.

Fields

Field	Type	Required	Description	Example
`capabilities`	List[models.CapabilityID]	✔️	List of capabilities you intend to request for this account. These values are used to determine what information to collect from the user during onboarding.	[ "transfers" ]
`fee_plan_codes`	List[str]	✔️	List of fee plan codes to assign the account created by the invitee.	[ "merchant-direct" ]
`return_url`	Optional[str]	➖	Optional URL to redirect the user to after they complete the onboarding process.	https://mycompany.com/account
`terms_of_service_url`	Optional[str]	➖	Optional URL to your organization's terms of service.	https://mycompany.com/terms-of-service
`scopes`	List[models.ApplicationScope]	➖	List of scopes you request to use on this account. These values are used to determine what can be done with the account onboarded.	[ "accounts.read" ]
`prefill`	OptionalNullable[models.Prefill]	➖	Optionally provide information already known about the recipient to save them time during onboarding.