Adding a New User

Adding a new user through the portal

1. Log in to your portal

2. Click Users > Add new

3. Select the Account type

4. Enter the General information

• 
  Email - This will not send out an automatic email to the user. It just helps create a unique ID for the user


• Phone Number - Optional

5. Click Save. The user will then be added to the database.

Note: The user will display as Not Connected. This is normal, you can still send funds to and from this user. Not Connected means they're not connected through aggregation. To set up a connected user, you need to use aggregation.

Adding a new user through Aggregation

The integration code to add a payment profile is an out-of-the-box solution. It is a URL you can:

• Embed it into your web app


• Send it directly to your user via email or SMS


• Display it on your computer for walk-in clients

Aggregation allows a user to link their bank account within minutes giving you access to their banking data and information. Their account verification is done almost instantly without the need for void cheques and bank statements. You can retrieve your payment profile (aggregation) URL by completing the following steps. 

1. Log in to your portal

2. Click Settings > Integration Codes

3. Click Add Payment Profile

4. Copy the URL. You can:

• embed the URL in your web app


• open it in any browser

You can customize the appearance of the link through settings > brand customization in your portal. You can also limit the options displayed by adding parameters to the URL. The list of parameters can be found in our documentation here.

Adding a new user through the API

Useful tips

• By passing the user object in the payload, you will initiate the transaction and generate a user profile so you can use the userID returned in the API response in future transactions.


• If you are using webhooks, you will receive a response each time the user status and transaction history update. 

There are two different ways to create a new user using the Zūm API.

Option 1: Calling the user endpoint

By using this option you are only creating a user that you can use to create transactions at a later date. 

{{env}}/api/user 

Click here to read more about the user endpoint.

Option 2: Calling the transaction endpoint and passing the user object

By using this option you are creating a user profile and a transaction at the same time.

{{env}}/api/transaction

Click here to read more about how to create a user profile and transaction simultaneously.