Sub-Merchant Onboarding by API in Canada: KYB, Documents and Statuses
Table of Contents
- What Is a Sub-Merchant Onboarding API?
- How Does Onboarding by API Work, Step by Step?
- Which KYB Documents Does a Sub-Merchant Provide?
- What Do the Onboarding Statuses Mean?
- Can Some Tenants Skip Onboarding?
- Build Your Own KYB Flow or Onboard Through TIB?
- What Does It Look Like for a Real Platform?
- How Do Other Providers Approach Onboarding?
- Who Reviews the Files and Supports Your Team?
- What Does It Cost?
- How Do You Get Started?
- Common Questions
A sub-merchant onboarding API lets your platform create each tenant as a sub-merchant, hand it an onboarding link, collect its KYB documents and track its status until it can accept payments, all from your own code. On TIB Finance, one CreateSubClient call creates the tenant and returns its ServiceId and a BoardingRedirectUrl. The tenant uploads three documents (a company document, a cheque specimen and the owner's ID), TIB's team reviews the file, and your software follows each status from Draft to Completed with GetServiceBoardingStatus. The whole flow works in English and in French.
This guide is for Canadian SaaS, vertical software and marketplaces that offer payments to the businesses on their platform. Here, tenants are those businesses, and each one becomes a sub-merchant of your platform once its onboarding is complete. This is also called merchant onboarding by API. It builds on our pillar page on multi-tenant payment processing.
In short: create the tenant by API, send it the onboarding link inside your app, let it upload three documents, follow its status from Draft to Completed, then go live. TIB carries the KYB review, and a real, bilingual team supports you from your first tenant on.
Talk to our team about your platform, or test in the free sandbox.
What Is a Sub-Merchant Onboarding API?
Know Your Business (KYB) is the verification a payment processor runs on a business before that business can collect money: who the company is, who owns it, and which bank account receives the funds. Know Your Customer (KYC) applies the same idea to a person. On a payment platform, every tenant goes through KYB, and an onboarding API turns that process into a few calls your software makes on its own, instead of emails, attachments and spreadsheets.
TIB Finance is built for B2B and multi-tenant payment processing. Businesses build their own platform on TIB, with their own tenants and sub-merchants underneath. The structure maps onto your product in four layers:
Each sub-client gets an isolated environment, and its ServiceId replaces yours in the calls you make on its behalf. Each account has its own bank account. For the full model, read our guide to multi-tenant payment architecture.
How Does Sub-Merchant Onboarding by API Work, Step by Step?
Seven steps take a tenant from sign-up in your app to its first payment:
- Create the tenant. Your platform calls CreateSubClient with the tenant's name, language and currency (CAD or USD, CAD by default). This call starts its onboarding.
- Get the onboarding link. The response returns the ServiceId of the tenant's default service, created automatically, and the BoardingRedirectUrl, the link to the onboarding wizard.
- Send the tenant to the link. Show it inside your app, as a button or in an email. The tenant uploads three documents: a company document, a cheque specimen and the owner's ID.
- Follow the statuses. The file moves through Draft, Submit, InReview and Completed. TIB's team reviews the file, so your team does not have to.
- Read the status from your code. GetServiceBoardingStatus returns the onboarding status of all merchants of a service. GetService shows the main merchant with its BoardingStatus, its BoardingFiles and HasCompletedBoarding.
- Add bank accounts when needed. AddBankAccount adds a bank account, as a new merchant, to a service that is already onboarded. It is authorized on insertion, without a new approval circuit, and inherits the owner and the currency of a sibling merchant.
- Go live. Once the status is Completed, the tenant collects with the payment methods enabled for its service, such as pre-authorized debit, EFT, Interac and credit cards, and every transaction event your webhook receives carries its MerchantId and MerchantName.
Webhooks follow the official webhook documentation: you give the URL of your endpoint to your TIB representative and allow the source IP range 204.225.113.0/24. The complete method reference is in the developer documentation, and the platform features are summarized on embedded payments for platforms, which lists multi-tenant onboarding by API among its features.
Which KYB Documents Does a Sub-Merchant Provide?
Three documents are required:
Company Document
Proof of the company's identity, so TIB knows exactly which business it is onboarding.
Cheque Specimen
Proof of the bank account that receives the tenant's funds.
Owner ID
Identification of the owner or shareholder behind the business.
In English or French
The flow is bilingual end to end: a tenant in Quebec City completes it in French, a tenant in Calgary in English.
Short and predictable is the point. A tenant knows what to prepare before it opens the link, and your support team knows what to answer. The documents go to TIB through the onboarding link, so your team never has to collect them by email or store them in your own systems.
What Do the Onboarding Statuses Mean?
Each tenant's file carries one status at a time. Your platform reads it and shows the tenant where it stands:
| Status | What it means | What your platform shows |
|---|---|---|
| Draft | The tenant has opened its file and is preparing its documents. | A reminder to finish the upload |
| Submit | The tenant has submitted its file. | Submitted, review coming up |
| InReview | TIB's team is reviewing the file. | A clear pending approval state |
| Completed | The file is approved and the tenant can process payments. | Payments switched on |
Design your sign-up screens around that pending approval state: the tenant sees its progress, and your code reads the status of every merchant of a service in a single call.
Can Some Tenants Skip Onboarding?
Yes, in eligible cases. ListServices exposes two flags: SkipClientApprobation, when the merchants created under the client are authorized immediately, and IsClientBoardingExempt, when the client is exempt from onboarding. For an exempt tenant, the BoardingRedirectUrl returned by CreateSubClient is null, so your code skips the link step and moves straight on. Which of your tenants qualify is a conversation to have with our team.
Build Your Own KYB Flow or Onboard Through TIB: How Do They Compare?
Three ways to get your tenants verified and ready to collect, side by side:
| What you need | Manual onboarding (email and forms) | In-house KYB build | TIB onboarding API |
|---|---|---|---|
| Document collection | Attachments by email, chased by hand | Upload screens and secure storage to build | Three documents through the onboarding link |
| File review | Your team, case by case | Your team, plus the rules to write | TIB's team |
| Status tracking | A spreadsheet | A status model to design | Draft, Submit, InReview, Completed, by API |
| Language | Whatever your team writes | Two versions to build and maintain | Bilingual end to end |
| Extra bank accounts | A new form each time | Your own approval logic | AddBankAccount, authorized on insertion |
| Card and bank data | Your exposure to manage | Your security program to carry | Drop-In form, no sensitive data on your servers |
| Support | Your team alone | Your team alone | A real, bilingual TIB team |
| Your developers' time | Spent on admin | Spent on compliance plumbing | Spent on your product |
The idea is simple: your platform owns the experience and the relationship, and TIB carries the verification. If you are weighing the bigger question of becoming a payment facilitator yourself, read our PayFac alternative guide.
What Does It Look Like for a Real Platform?
Take a Quebec property management platform that signs up a new management company with three buildings, each with its own bank account:
- The company signs up in the platform. The platform calls CreateSubClient in French, in CAD, and stores the ServiceId.
- The onboarding screen shows a Complete your verification button that points to the BoardingRedirectUrl. The manager uploads the company document, a cheque specimen and her ID.
- The platform calls GetServiceBoardingStatus and shows Under review while the file is InReview.
- At Completed, rent collection by pre-authorized debit switches on. The two other buildings get their bank accounts through AddBankAccount, with no new approval circuit.
- Every rent payment event arrives by webhook with the MerchantId of the right building, ready for reconciliation.
Payouts follow the same structure: owner payouts and refunds can go out as instant payments, in seconds, 24/7/365, through TIB's own system. See instant payouts for platforms and our instant payments page.
How Do Zum Rails and VoPay Approach Merchant Onboarding?
Both offer their own onboarding tools. Zum Rails markets AI-powered KYC, and its onboarding takes every customer and every partner through underwriting. VoPay offers a white-label onboarding application that one endpoint of its API generates, and its onboarding can start with an ID verification step (all verified November 22, 2026).
Two announcements are also worth knowing. In September 2024, Zum Rails formally established its U.S. headquarters in Miami and announced that its CEO would permanently relocate there. It said it was preparing for at least 50% of its overall revenue to originate in the U.S. within the following 18 months. Its CA$10.5M Series A was led by Arthur Ventures, a Minneapolis firm. VoPay announced its global headquarters in Doha, Qatar, in January 2026, and vopay.com/fr-ca/ returns a page-not-found error: there is no French VoPay site (all verified November 22, 2026). Full comparisons: TIB Finance vs Zum Rails and TIB Finance vs VoPay.
For a platform with tenants in Quebec, language is part of onboarding. On TIB, the onboarding flow, the site and the team work in French and in English, end to end.
Who Reviews the Files and Supports Your Team?
TIB Finance is a sovereign Canadian payment processor, headquartered in Montreal and founded in 2018. It is registered as a payment service provider with the Bank of Canada under the RPAA (see what that registration means). Proven, solid, and there for its clients, its partners and the platforms that build on it: TIB processes over $600 million a year for 1,000+ businesses and handles 200,000+ transactions every month.
The service is what you feel first. A real, bilingual human team supports every client and every partner. TIB Finance sends people: our integration team works inside your processes until payments run on their own, and integration is free for eligible businesses (see business integration). The Drop-In secure payment form accepts cards and bank payments in your app without your servers handling sensitive data, and TIB is certified PCI DSS Level 1. Payment pages can carry your colours and logo, so your tenants' customers see your platform. More on that in our guide to white-label payment platforms in Canada.
What Does Onboarding Sub-Merchants on TIB Cost?
Plans from $25/month, with pricing adapted to your volume and model: talk to our team. We map the setup for your tenants with you before anything goes live, and choosing a provider is easier with our embedded payments provider checklist.
How Do You Get Started?
Four ways in:
Talk to Our Team
A bilingual payment expert reviews your platform, your tenants and your onboarding flow. Request a call.
Become a Partner
For platforms and integrators who bring their clients to TIB: a $250 gift card on your first mandate and up to 60% in commissions. Join the partner network.
Test in the Sandbox
Free, with API credentials by email, to test every payment flow end to end. Open a sandbox.
Open an Account
Ready for your own payment account? Open your business payment account online.
Common Questions
What is a sub-merchant onboarding API?
It is a set of API calls that lets a payment platform create each of its tenants as a sub-merchant, send it an onboarding link, collect its KYB documents and track its status until it can accept payments. On TIB Finance, CreateSubClient creates the tenant and returns its ServiceId and its onboarding link, and GetServiceBoardingStatus returns its status.
Which documents does TIB need to onboard a sub-merchant?
Three documents: a company document, a cheque specimen for the bank account that receives the funds, and the owner's ID. The tenant uploads them through its onboarding link, in English or in French.
What are the onboarding statuses on TIB?
A file moves through four statuses: Draft, Submit, InReview and Completed. Once the status is Completed, the tenant can process payments.
How does my platform know when a tenant is ready?
Your code calls GetServiceBoardingStatus, which returns the onboarding status of all merchants of a service, or GetService, which shows the main merchant with its BoardingStatus, its BoardingFiles and HasCompletedBoarding.
Can a tenant complete onboarding in French?
Yes. The flow is bilingual end to end: each tenant is created with its own language, and TIB's team supports every client and every partner in French and in English.
Can a tenant add another bank account after onboarding?
Yes. AddBankAccount adds a bank account, as a new merchant, to a service that is already onboarded. It is authorized on insertion, without a new approval circuit, and inherits the owner and the currency of a sibling merchant.
Do I need to become a payment facilitator to onboard sub-merchants?
No. On TIB Finance, your platform onboards its tenants by API while TIB carries the KYB review and the PCI DSS Level 1 infrastructure. Our PayFac alternative guide compares the options.
Can I test before my first tenant goes live?
Yes. The free sandbox comes with API credentials by email, so your developers can test every payment flow end to end before your first tenant goes live.
How much does sub-merchant onboarding cost on TIB?
Plans from $25/month, with pricing adapted to your volume and model. Talk to our team for a proposal that fits your platform.
Let's Talk About Onboarding Your Tenants
Let's chat about your project: tell us about your tenants and your sign-up flow, and our bilingual team will map the onboarding with you.
Talk to Our Team Become a Partner