How it Works

Authentication

All API requests use the Bearer Token Authorization. See Authentication for details.

Identity Verification

Zūm Rails' card onboarding platform collects the required information from the cardholder, including personal details and verification documents such as a valid government-issued ID, proof of address, or other supporting documentation.

The onboarding platform is a web form hosted by Zūm Rails that handles the collection of identity verification information from card applicants. You can use our hosted card onboarding URL or integrate the process into your application’s embedded flow using our SDK. See Zum Connect for integration details.

Identity Verification Process Below is the two-step identity verification flow required to meet Zūm Rails’ KYC requirements:

1. Profile Setup – Collects the applicant’s full name, email address, and phone number.

2. ID Verification – Includes a selfie, upload of a valid government-issued ID, and occupation information.

Here’s a preview of the form used in Zūm Rails’ sample integration:

How to access your unique card onboarding URL/SDK

• 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”

How to customize your card onboarding URL/SDK

• 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.

Available notifications

• After the card applicant completes the card onboarding flow, based on your configuration and level of integration, if applicable, the following will occur:

Emails from Zum Rails

Email(s) To	Reason for Email(s)
Customer	Notification of card application submitted, approved, under review and declined
Cardholder	Notification of card application submitted, approved, under review and declined

Card Issuance

Upon receiving card application has passed the identify verification, a Partner and Customer can approve the card with the Approve Card endpoint in User API. This endpoint verifies that the identity verification process has been completed.

You can also do this on our portal on the users page.

Available notifications

If you have the configuration, the following emails will be sent.

Emails from Zum Rails

Email(s) To	Reason for Email(s)
Customer	Notification of card is issued successfully
Cardholder	Notification of card is issued successfully

Card Management

Display full card details

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”

Add a new card to a user

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 Get Card Accounts endpoint in Card API.

Available notifications

Emails from Zum Rails

Email(s) To	Reason for Email(s)
Cardholder	Notification of new card being added

Activate the users current card

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 Activate endpoint in Card API to activate your user's card.

Available notifications

Emails from Zum Rails

Email(s) To	Reason for Email(s)
Cardholder	Notification of card being activated

Change the card program of a user's current 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 Change Card Program endpoint in Card API. The card program id you input must be added to the list during customer configuration.

You can also do this on our portal through the user detail page.

Available notifications

Emails from Zum Rails

Email(s) To	Reason for Email(s)
Cardholder	Notification that the users card has changed card programs

Get the balance on a user's current card

You can view a user's current card balance through the Get Balance Inquiry endpoint in Card API.

Get all cards attached to a user

You can view a user's cards through the Get Card Accounts endpoint in Card API.

Update the status on a user's current card

You can update the user’s current card status through our Set Card Status endpoint in Card API.

You can also do this through our portal on the users detail page.

Available notifications

Emails from Zum Rails

Email(s) To	Reason for Email(s)
Cardholder	Notification of what the card status is changed to

Get the status of a user's current card

You can view a user's current card status through the Get Card Status endpoint in Card API.

Update card profile

There are 3 different endpoints we have to update the card profile.

• Update Basic Information endpoint in User API

• Update Shipping Information endpoint in User API

• Update Prepaid Card Information endpoint in User API

You can also do this through our portal on the users edit detail page.

Available notifications

Emails from Zum Rails

Email(s) To	Reason for Email(s)
Cardholder	Notification of card profile updates (name, address, date of birth, occupation, phone number)

Funding

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.

Call the Transaction endpoint in the Transaction API.

Available notifications

Emails from Zum Rails

Email(s) To	Reason for Email(s)
Cardholder	Notification for transactions (Approved, Pending, Declined)