For the complete documentation index, see llms.txt. This page is also available as Markdown.
Adding a New User
Adding a new user through the portal
Log in to your portal
Click Users > Add new
Select the Account type
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
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.
Log in to your portal
Click Settings > Integration Codes
Click Add Payment Profile
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.
Adding a new user through the API
Useful tips
By bypassing 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
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.
