Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Use cases API Changelog
  1. API reference
  2. Moov accounts
  3. Onboarding

Get onboarding invite

Retrieve details about an onboarding invite.
GET
/onboarding-invites/{code}
200 404 429
The onboarding invite.
Invitation to onboard an organization with Moov.
{
  "capabilities": [
    "transfers"
  ],
  "code": "KXc1omVfbQ",
  "createdOn": "2019-08-24T14:15:22Z",
  "feePlanCodes": [
    "merchant-direct"
  ],
  "link": "https://dashboard.moov.io/o/KXc1omVfbQ",
  "partner": {
    "accountID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "accountMode": "production",
    "displayName": "Bob's Widgets"
  },
  "prefill": {
    "profile": {
      "business": {
        "legalName": "Bob's Widgets"
      }
    }
  },
  "redeemedAccountID": "2019-08-24T14:15:22Z",
  "redeemedOn": "2019-08-24T14:15:22Z",
  "returnURL": "https://mycompany.com/account",
  "revokedOn": "2019-08-24T14:15:22Z",
  "scopes": [
    "accounts.read"
  ],
  "termsOfServiceURL": "https://mycompany.com/terms-of-service"
}
No onboarding invite with the specified code was found.
Request was refused due to rate limiting.

Response headers

X-Retry-In

string <duration>
How long (in milliseconds) to wait until able to retry the request.

Path parameters

code

string required
The unique code that identifies the onboarding invite.

Response

application/json
Invitation to onboard an organization with Moov.

capabilities

array required
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.
Possible values: transfers, send-funds, collect-funds, wallet, card-issuing

code

string required
Code that uniquely identifies this invitation. This code is used to redeem the invitation.

createdOn

string<date-time> <=24 characters required

feePlanCodes

array required
List of fee plan codes to assign the account created by the invitee.

link

string<uri> required
A unique URL, including the invite code, that the recipient can follow to redeem the invitation.

scopes

array required
List of scopes you request to use on this account. These values are used to determine what can be done with the account onboarded.
Possible values: accounts.read, accounts.write, analytics.read, apple-pay-merchant.read, apple-pay-merchant.write, apple-pay.read, apple-pay.write, bank-accounts.read, bank-accounts.write, capabilities.read, capabilities.write, cards.read, cards.write, documents.read, documents.write, fed.read, files.read, files.write, issued-cards.read, issued-cards.write, issued-cards.read-secure, payment-methods.read, ping.read, profile-enrichment.read, profile.read, profile.write, profile.disconnect, representatives.read, representatives.write, transfers.read, transfers.write, wallets.read

partner

object
The account that created the onboarding invite.
right_key Show child attributes

accountID

string<uuid>
The unique identifier for the account that created the onboarding invite.

accountMode

string<enum>
The mode this account is allowed to be used within.
Possible values: sandbox, production

displayName

string
The name of the Moov account used to create the onboarding invite.

prefill

object
Optionally provide information already known about the recipient to save them time during onboarding.
Describes the fields available when creating a Moov account.
right_key Show child attributes

accountType

string<enum> required
The type of entity represented by this account.
Possible values: individual, business

capabilities

array
The list of capabilities to request when the account is created.
Possible values: transfers, send-funds, collect-funds, wallet, card-issuing

customerSupport

object
User-provided information that can be displayed on credit card transactions for customers to use when contacting a customer support team. This data is only allowed on a business account.
right_key Show child attributes

address

object
right_key Show child attributes

addressLine1

string <=60 characters required

addressLine2

string <=32 characters

city

string <=24 characters required

country

string <=2 characters required

postalCode

string <=5 characters required

stateOrProvince

string <=2 characters required

email

string<email> <=255 characters Pattern
Email address.

phone

object
right_key Show child attributes

countryCode

string <=1 characters

number

string<phone> <=10 characters

website

string <=100 characters

foreignID

string <=64 characters
Optional alias from a foreign/external system which can be used to reference this resource.

metadata

object
Free-form key-value pair list. Useful for storing information that is not captured elsewhere.

mode

string<enum>
The mode this account is allowed to be used within.
Possible values: sandbox, production

profile

object required
Describes the fields available when creating a profile. If accountType is set to individual, the individual object should be completed. All others should populate business.
right_key Show child attributes

business

object
Describes the fields available when creating a business.
right_key Show child attributes

address

object
right_key Show child attributes

addressLine1

string <=60 characters required

addressLine2

string <=32 characters

city

string <=24 characters required

country

string <=2 characters required

postalCode

string <=5 characters required

stateOrProvince

string <=2 characters required

businessType

string
The type of entity represented by this business.
Possible values: soleProprietorship, unincorporatedAssociation, trust, publicCorporation, privateCorporation, llc, partnership, unincorporatedNonProfit, incorporatedNonProfit, governmentEntity

description

string [10 to 100] characters

doingBusinessAs

string <=64 characters Pattern

email

string<email> <=255 characters Pattern
Email address.

industryCodes

object
Describes industry specific identifiers.
right_key Show child attributes

mcc

string 4 characters

naics

string [2 to 6] characters

sic

string 4 characters

legalBusinessName

string <=64 characters required Pattern

phone

object
right_key Show child attributes

countryCode

string <=1 characters

number

string<phone> <=10 characters

primaryRegulator

string
If the business is a financial institution, this field describes its primary regulator.
Possible values: OCC, FDIC, NCUA, FRB

taxID

object
An EIN (employer identification number) for the business. For sole proprietors, an SSN can be used as the EIN.
right_key Show child attributes

ein

object
right_key Show child attributes

number

string <=64 characters

website

string <=100 characters

individual

object
Describes the fields available when creating an individual.
right_key Show child attributes

address

object
right_key Show child attributes

addressLine1

string <=60 characters required

addressLine2

string <=32 characters

city

string <=24 characters required

country

string <=2 characters required

postalCode

string <=5 characters required

stateOrProvince

string <=2 characters required

birthDate

object
An individual’s birthdate.
right_key Show child attributes

day

integer required

month

integer required

year

integer required

email

string<email> <=255 characters Pattern
Email address.

governmentID

object
right_key Show child attributes

itin

object
right_key Show child attributes

full

string <=64 characters

lastFour

string <=4 characters

ssn

object
right_key Show child attributes

full

string <=64 characters

lastFour

string <=4 characters

name

object required
An individual’s name.
right_key Show child attributes

firstName

string <=64 characters required Pattern
Name this person was given. This is usually the same as first name.

lastName

string <=64 characters required Pattern
Family name of this person. This is usually the same as last name.

middleName

string <=64 characters Pattern
Name this person was given. This is usually the same as first name.

suffix

string <=20 characters Pattern
Suffix of a given name.

phone

object
right_key Show child attributes

countryCode

string <=1 characters

number

string<phone> <=10 characters

settings

object
User provided settings to manage an account.
right_key Show child attributes

achPayment

object
User provided settings to manage ACH payments.
right_key Show child attributes

companyName

string [1 to 16] characters Pattern
The description that shows up on ACH transactions. This will default to the account’s display name on account creation.

cardPayment

object
User provided settings to manage card payments. This data is only allowed on a business account.
right_key Show child attributes

statementDescriptor

string [4 to 22] characters Pattern
The description that shows up on credit card transactions. This will default to the accounts display name on account creation.

termsOfService

object
Describes the acceptance of the Terms of Service.
right_key Show child attributes
Token Manual entry
An encrypted value used to record acceptance of Moov’s Terms of Service.

token

string
Describes the acceptance of the Terms of Service. All data is required, and must be from the user.

acceptedDate

string<date-time> <=24 characters

acceptedDomain

string<url> <=255 characters

acceptedIP

string<ipv4> <=15 characters

acceptedUserAgent

string <=255 characters
The user-agent of the user making the request.

redeemedAccountID

string
If redeemed, this is set to the accountID that redeemed it

redeemedOn

string
If redeemed, the date and time the invitation was redeemed.

returnURL

string<uri>
Optional URL to redirect the user to after they complete the onboarding process.

revokedOn

string
If revoked, the date and time the revocation was requested.

termsOfServiceURL

string<uri>
Optional URL to your organization’s terms of service.