Account

Accounts represent a legal entity (either a business or an individual) in Moov. You can create an account for yourself or set up accounts for others. You can retrieve an account to get details on the business or individual account holder, such as an email address or employer identification number (EIN). You can also look at the account object to see what capabilities that account has.

Create account

You can create accounts for your users by passing the required information to Moov. Note, capabilities can be requested during account creation, or you can request capabilities as needed later on.

To create an account, you’ll need to specify the /accounts.write scope when generating a token.

Parameters

Name Type
account Account
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
const updatedAccount = {
  "accountType": "business",
  "profile": {
    "business": {
      "legalBusinessName": "ClassBooker",
      "businessType": "llc",
    }
  } 
};
moov.accounts.update(updatedAccount);

Get account

Retrieves details for the account with the specified ID.

To retrieve an account, you’ll need to specify the /accounts/{accountID}/profile.read scope when generating a token.

Parameters

Name Type
accountID UUID string
1
moov.accounts.get({accountID});

Update account

If an account’s details have changed, you can update the information associated with a specific account ID.

To update an account, you’ll need to specify the /accounts/{accountID}/profile.write scope when generating a token.

Parameters

Name Type
accountID UUID string
account account

Platform terms of service agreement

Each account using the wallet, send-funds, or collect-funds capabilities must agree to Moov’s terms of service before a transfer can be created with that account. In your application, you must display a link to the Moov platform agreement, and the terms must be accepted by the user.

To accept the platform agreement terms of service via Moov.js, you can pass the accountID into the following method. This will generate a terms of service token and update the account in one step.

Name Type
accountID UUID string
1
 moov.accounts.acceptTermsOfService({ accountID: "..." } );

If you need to generate a terms of service token to pass to the Moov API, you can call the following method.

1
 moov.accounts.getTermsOfServiceToken();

If needed, you can manually enter the terms of service information via Moov’s API with the accounts POST endpoint when creating an account, or with the accounts PATCH endpoint when updating an account.

Check out out our pre-built terms of service Drop. With the pre-built user interface, you can integrate our privacy policy and terms of service while simultaneously generating a token that can be patched to the account.
Summary Beta