Reseller onboarding insights
Evaluate the onboarding and verification of the merchants in your portfolio.
As a reseller, you can see the onboarding and verification progress of every merchant in your portfolio. You can use this information for the following purposes:
- Get a complete view of your merchants' onboarding progress: how many are fully verified, how many are on each verification tier, and how many are closed or suspended.
- Quickly find and address verification issues as they come up, so that your merchants have a smooth onboarding experience.
- Use the data to improve your onboarding flow for future merchants.
To view the verification details of one merchant, see their KYC summary.
Access the insights
Use the Resellers API with your partner API key. Datman always takes the reseller from your API key, so you only see your own merchants. If you also send resellerId, it must match your API key's reseller, otherwise the response is HTTP 403.
The insights come from two requests:
- The summary: make a Get onboarding totals across the reseller's merchants request. Send
{}as the body when you have nothing else to pass: the body must be valid JSON. - The merchant list: make a List onboarding status for the reseller's merchants request.
Datman caches both responses for a short time, so the data can be up to two minutes old. The X-Onboarding-Cache response header is HIT when the response came from the cache, and MISS otherwise.
Explore onboarding metrics
The following tabs show the metrics you can monitor.
Use these counts to assess the overall onboarding performance of your portfolio. They are in the data.summary object of the response.
| Metric | Description |
|---|---|
total_merchants | The number of merchants in your portfolio. |
fully_verified | Merchants whose bank, business and owner details are verified, who have accepted the terms of service, and whose account and payouts are active. |
staggered_onboarding | Merchants whose account and payouts are both active. |
up_to1000 | Merchants on verification tier Tier 1. |
up_to5000 | Merchants on verification tier Tier 2. |
closed_or_suspended | Merchants whose account is closed or suspended. |
Note that all counts except total_merchants may be returned as numeric strings, for example "25". When you have no merchants, they are null.
Use cases
These typical scenarios show how the onboarding insights help you.
Monitor your overall onboarding performance
To make sure your onboarding process works well, and to find bottlenecks, keep an eye on the key counts. For example:
-
Completion of onboarding. Compare
fully_verifiedwithtotal_merchants. A high share of fully verified merchants means most merchants complete onboarding and can be paid out. A high number of merchants who stay on a verification tier means merchants may have problems submitting their data. Then, check the merchant list to find and fix the issues.Metrics to analyse:
total_merchants,fully_verified,up_to1000,up_to5000
Troubleshoot onboarding
If many merchants aren't fully verified, check the merchant list for the onboarding areas that are not verified. For example, if many merchants have bank_status 0, make sure your onboarding flow explains clearly which bank documents your merchants must provide.
Metrics to analyse: business_status, owner_status, bank_status, tos_status in the merchant list
Evaluate the effectiveness of interventions
You can measure the effect of changes you make. For example, you have added examples of the required bank documents to your onboarding flow. To check whether this helped, compare the number of merchants with bank_status 1 before and after the change, and check whether fully_verified has gone up.
Metrics to analyse: fully_verified, bank_status
Conduct a comparative analysis
If you onboard merchants in several countries, compare the merchant list by country to see how well your onboarding performs in each market.