Skip to content

Customers

Customers can be created and retrieved from Moov.js.

Quick enroll link

moov.customers.quickEnroll(options?)

Quick enroll orchestrates creating a customers, connecting an account, and setting statement delivery options in one request and response.

Parameters link

  • customer
  • account
  • statementDeliveryOptions

Returns link

This method returns a Promise which resolves with the results object which includes the customer and account.


Get customer link

moov.customers.get(options?)

Retrieve a customer by its customerID or by the foreignID that you set. Lookup by foreignID makes it easy for you to use the user ID from your system to find the customer in Moov.

Parameters link

  • customerID
  • foreignID

Returns link

This method returns a Promise which resolves with the results object that includes the customer if found.


Get statement delivery options link

moov.customers.getCustomerDeliveryOptions(options?)

Determine whether the customer has opted in to electronic delivery of documents.

Parameters link

  • customerID

Returns link

This method returns a Promise which resolves with the results object that includes the delivery options.