How it Works
Last updated
Was this helpful?
Last updated
Was this helpful?
All API requests use the Bearer Token Authorization. See for details.
Zum Rails card onboarding platform collects the required information from the cardholder. This includes personal information and document collection, such as a valid government-issued ID, a proof of address document, or other verification documents.
The card onboarding platform is a web form hosted by Zum Rails that takes care of collecting identity verification information from the card applicant. You can leverage our card onboarding URL or SDK within your applications embedded flow. See for integration details.
Profile Setup (Full Name, Email Address, and Phone Number)
ID Verification (Selfie, Valid Government-Issued ID upload, Occupation)
Here’s what the form looks like for Zum Rails’s sample integration:
Navigate to Settings → Integration Codes page
For the URL, click on the Embedded Codes tab and locate the Card Onboarding banner to find your unique card onboarding URL
For SDK, click on the JavaScript SDK and locate the Card Onboarding banner to find the “ConnectTokenType”: “Card Onboarding”
Navigate to Settings → Brand Customization to customize the visual appearance of the form and logo. You must provide the name, color, and icon of your brand.
After the card applicant completes the card onboarding flow, based on your configuration and level of integration, if applicable, the following will occur:
Customer
Notification of card application submitted, approved, under review and declined
Cardholder
Notification of card application submitted, approved, under review and declined
You can also do this on our portal on the users page.
If you have the configuration, the following emails will be sent.
Customer
Notification of card is issued successfully
Cardholder
Notification of card is issued successfully
You can use our SDK to display the sensitive data of your issued cards on your application.
Go to Settings → Integration Codes → JavaScript SDK to locate the View Card Information banner to find the “ConnectTokenType”: “ViewCardInformation”
Cardholder
Notification of new card being added
Cardholder
Notification of card being activated
You can also do this on our portal through the user detail page.
Cardholder
Notification that the users card has changed card programs
You can also do this through our portal on the users detail page.
Cardholder
Notification of what the card status is changed to
There are 3 different endpoints we have to update the card profile.
You can also do this through our portal on the users edit detail page.
Available notifications
Cardholder
Notification of card profile updates (name, address, date of birth, occupation, phone number)
To add funds to the card, you can add funds from your Zum Wallet.
To remove funds from the card, you can remove funds back to your Zum Wallet.
Available notifications
Cardholder
Notification for transactions (Approved, Pending, Declined)
Upon receiving card application has passed the identify verification, a Partner and Customer can approve the card with the This endpoint verifies that the identity verification process has been completed.
If your user wants a new card for some reason, you can use the Add Card endpoint in Card API to create a new card and attach it to your user. The old card will be detached from our database but we can still access the information via
Once your card has been approved or you create a new card, you need to activate the card to access higher level security endpoints. You can use the to activate your user's card.
The card program is attached to custom transaction limitations and cardwork. To change the card program attached to a user's card, call the . The card program id you input must be added to the list during customer configuration.
You can view a user's current card balance through the
You can view a user's cards through the .
You can update the user’s current card status through our
You can view a user's current card status through the .
