1. Guides
2. Moov accounts

Generate a link to a co-branded onboarding application from the Dashboard or our API. Any existing information you have for merchants, such as names and addresses, can be pre-filled. When you send a link, a secure session is created and merchants are prompted to complete the form and sign up for access to Moov. Merchants can be redirected to your app upon completion.

Merchant experience

Merchants will need to create an account with Moov to access the form. During this process, they’ll give permission for you to move money and perform actions on behalf of their account, and they’ll view and agree to the pricing disclosure for the plan you’ve selected.

Once an account has been created, they can start and pause the session, filling out the form at their convenience. Merchants need to double check any pre-filled information for accuracy.

In addition to basic information, business accounts will be required to provide owners and control officers. The onboarding form supports uploading documents for this purpose.

Your branding

Hosted onboarding contains several references to your own brand, including:

• Your logo and company name displayed throughout the onboarding flow
• Page title and meta description includes your company name
• Social share image includes your logo
• Accent colors for both light and dark mode
• If set, the returnURL will redirect the user to your app upon completion of the form
• If set, termsOfServiceURL will reference your terms of service within the hosted onboarding flow alongside Moov’s platform agreement and privacy policy

Brand accent colors can be set by navigating to Settings in the Dashboard or with the enrichment API. The return URL and terms of service URL can be set when creating an onboarding link in the Dashboard or with the onboarding API.

Create a link

Create a link and send a form to merchants to fill out at their convenience. Form links will expire upon completion and attempts by a merchant to access a completed form will result in a 404 error.

When you create a link you’ll need to provide the desired account type, capabilities, and fee plan. Read the capabilities and fee plan guides for details. You’ll also need to provide the list of scopes you want to use on the account.

Use the onboarding POST endpoint to create an onboarding link. You’re required to send the following with your request:

• Capabilities
• Fee plan codes for the account
• Scopes

Additionally, you can choose to send a custom return URL, your terms of service URL, and prefill any merchant data.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

curl --X POST "https://api.moov.io/onboarding-invites" \
  -H "Authorization: Bearer {token}" \
  --data-raw '{
    "returnURL": "https://mycompany.com/account",
    "termsOfServiceURL": "https://mycompany.com/terms-of-service",
    "scopes": [
     "accounts.read"
    ],
    "capabilities": [
      "transfers"
    ],
    "feePlanCodes": [
      "merchant-direct"
    ],
    "prefill": {
      "mode": "production",
      "accountType": "business",
      "profile": {
        "business": {
          "legalBusinessName": "Whole Body Fitness LLC",
          "doingBusinessAs": "Whole Body Fitness",
          "businessType": "llc",
          "address": {
            "addressLine1": "123 Main Street",
            "addressLine2": "Apt 302",
            "city": "Boulder",
            "stateOrProvince": "CO",
            "postalCode": "80301",
            "country": "US"
          },
          "phone": {
            "number": "8185551212",
            "countryCode": "1"
          },
          "email": "amanda@classbooker.dev",
          "website": "www.wholebodyfitnessgym.com",
          "description": "Local fitness center paying out instructors",
          "taxID": {
            "ein": {
              "number": "123-45-6789"
            }
          },
          "industryCodes": {
            "naics": "713940",
            "sic": "7991",
            "mcc": "7997"
          },
          "primaryRegulator": "FDIC"
        }
      },
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "termsOfService": {
        "token": "kgT1uxoMAk7QKuyJcmQE8nqW_HjpyuXBabiXPi6T83fUKRJkA3dsFID6fzitMpm2qrOh4"
      },
      "foreignID": "4528aba-b9a1-11eb-8529-0242ac13003",
      "customerSupport": {
        "phone": {
          "number": "8185551212",
          "countryCode": "1"
        },
        "email": "amanda@classbooker.dev",
        "address": {
          "addressLine1": "123 Main Street",
          "addressLine2": "Apt 302",
          "city": "Boulder",
          "stateOrProvince": "CO",
          "postalCode": "80301",
          "country": "US"
        },
        "website": "www.wholebodyfitnessgym.com"
      },
      "settings": {
        "cardPayment": {
          "statementDescriptor": "Whole Body Fitness"
        },
        "achPayment": {
          "companyName": "Whole Body Fitness"
        }
      },
      "capabilities": [
        "transfers"
      ]
    }
  }'\

Manage onboarding invites

List all invites using the API. The response will have the code for each invite. The onboarding link code is required to retrieve an individual invite or revoke an invite.

Revoking an invite renders the link unusable.

Status

The easiest way to track an onboarding link’s status through the Dashboard, under Accounts > Onboarding links.

You can track whether a merchant has created an account and started to complete the form. The Dashboard will also alert you if newly created accounts have any outstanding capability requirements.m