LogoLogo
ChangelogFAQsStatus
  • Introduction
  • Getting Started
    • Your Zum Rails Account
    • Developer Quickstart
  • Payments
    • Introduction
    • Payment Rails
    • Bank Payments
      • EFT
      • ACH
      • RTP/FedNow
    • Interac e-Transfer
      • Send & Request
      • Review Transactions
    • Card Payments
      • Visa Direct
      • Credit Card
      • Push-to-debit
  • CARD ISSUANCE
    • Introduction
  • How it Works
  • User Tokenization
    • Zūm Connect
  • Invoices & Subscriptions
    • Overview
    • Products
    • Invoices
    • Subscriptions
  • Data Aggregation
    • Overview
    • Use Cases
    • Supported Institutions
    • Data
    • How it works
    • Testing
  • Insights
    • Overview
    • Income
    • Expenses
    • Insights
  • Brand Customization
    • Brand Customization
  • API Reference
    • Overview
    • Authentication
    • Users
    • Cards
    • Transactions
    • Funding Source
    • Products
    • Product Prices
    • Invoices
    • Subscriptions
    • Aggregation
    • Insights
    • Wallets
    • Operations
      • Transaction Limits
      • Review Transactions
      • Daily Auto-Withdrawal Summary
    • Webhooks
    • Errors
    • Idempotency
    • Country & Region Codes
  • Archived Documentation
Powered by GitBook
On this page
  • Authentication
  • Identity Verification
  • Card Issuance
  • Card Management
  • Display full card details
  • Add a new card to a user
  • Activate the users current card
  • Change the card program of a user's current card
  • Get the balance on a user's current card
  • Get all cards attached to a user
  • Update the status on a user's current card
  • Get the status of a user's current card
  • Update card profile
  • Funding

Was this helpful?

How it Works

PreviousIntroductionNextZūm Connect

Last updated 2 days ago

Was this helpful?

Authentication

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

Identity Verification

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.

Find below the two-step process to our identity verification flow to meet Zum Rails’ KYC requirements:

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

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:

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

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.

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

Available notifications

Email(s) To
Reason for Email(s)

Cardholder

Notification of new card being added

Activate the users current card

Available notifications

Email(s) To
Reason for Email(s)

Cardholder

Notification of card being activated

Change the card program of a user's current card

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

Available notifications

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

Get all cards attached to a user

Update the status on a user's current card

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

Available notifications

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

Update card profile

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

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.

Available notifications

Email(s) To
Reason for Email(s)

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 .

Authentication
Zum Connect
Call the Transaction endpoint in the Transaction API.
Approve Card endpoint in User API.
Update Basic Information endpoint in User API
Update Shipping Information endpoint in User API
Update Prepaid Card Information endpoint in User API
Get Card Accounts endpoint in Card API.
Activate endpoint in Card API
Change Card Program endpoint in Card API
Get Balance Inquiry endpoint in Card API.
Get Card Accounts endpoint in Card API
Set Card Status endpoint in Card API.
Get Card Status endpoint in Card API