1. Node SDK

Every Moov API request requires a valid OAuth token. Our authentication flow follows the OAuth 2.0 standard. When making requests from the browser, you’ll also need to request scope enums when generating a token. If a scope enum is required, it will be listed with the example.

GenerateToken

Generates an OAuth token required by Moov API requests. For more on our authentication protocol, read our quick start guide.

1

moov.generateToken(scopes, accountID)

Parameters

Returns

Promise.<Token>

You only need call this function when generating tokens for Moov.js and Moov Drops. The other functions in this library generate tokens for you automatically.

Examples

1
2
3
4
5

const moov = new Moov(...);
const token = await moov.generateToken([
  SCOPES.ACCOUNTS_CREATE,
  SCOPES.PING
]);

Ping

Pings the Moov servers to check for connectivity. Read more about /ping.

1

moov.ping()

Examples

1
2
3
4
5
6
7

const moov = new Moov(...);
try {
  await moov.ping();
  // Ping succeeded
} catch (err) {
  // Ping failed
}

Types

Token

OAuth2 token returned by Moov.generateToken(). Use Token.token in Moov.js and client-side code to make calls to the Moov API.

Properties

Enums

SCOPES

For client-side integration, you’ll need to request scopes when generating an OAuth token. See available scopes below: