Invitation to onboard an organization with Moov.
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
code |
str | ✔️ | Code that uniquely identifies this invitation. This code is used to redeem the invitation. |
KXc1omVfbQ |
link |
str | ✔️ | A unique URL, including the invite code, that the recipient can follow to redeem the invitation. |
https://dashboard.moov.io/o/KXc1omVfbQ |
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" ] |
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" ] |
created_on |
date | ✔️ | N/A | |
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 |
prefill |
OptionalNullable[models.OnboardingInvitePrefill] | ➖ | Optionally provide information already known about the recipient to save them time during onboarding. |
{ "accountType": "business", "profile": { "business": { "legalBusinessName": "Bob's Widgets LLC" } } } |
partner |
Optional[models.PartnerAccount] | ➖ | The account that created the onboarding invite. |
|
revoked_on |
date | ➖ | If revoked, the date and time the revocation was requested. |
|
redeemed_on |
date | ➖ | If redeemed, the date and time the invitation was redeemed. |
|
redeemed_account_id |
date | ➖ | If redeemed, this is set to the accountID that redeemed it |