Onboard and verify merchants

Your merchant's business type and country determine the verification information you need to collect. You can let your merchant enter it on a hosted page, or collect it in your own UI and send it with the API.

• Hosted onboarding: create the merchant with a few API calls, then send your merchant a link to a hosted page where they enter their information.
• API onboarding: build your own UI and collect the required merchant data. You send the data to Datman when you create the merchant, fill in any gaps later, and upload the KYC documents with the API. This gives you full control over the merchant's journey within your platform.

In both cases, you start by creating the merchant, and Datman issues a MID. After Datman receives the merchant's information, the verification process starts automatically.

RequirementsCopy Anchor Link

Before you begin, take into account the following requirements, limitations, and preparations.

Hosted onboardingCopy Anchor Link

Hosted onboarding needs less integration effort, because your merchant provides their information directly on a hosted page.

You can onboard merchants with any of the business types available in their country.

To implement hosted onboarding:

1. Make a merchant association request with action create and your merchant's details. Datman creates the merchant and issues a MID.
2. The response contains a signup_link when Datman created a new user for your merchant. Send it to your merchant, so they can complete sign-up for the merchant portal.
3. Get a link to the hosted onboarding page, and send it to your merchant. Choose one of the following options:
   • Make a Get onboarding status request. The data object in the response contains the hosted onboarding link. Send this link to your merchant.
   • Make a GET request to the shareable onboarding link endpoint, with the merchant ID and the platform name, with the exact casing the API reference lists (for example Mypay). The response body is the link itself. Datman creates the link, or reuses an existing one, and checks the merchant's verification again 2, 24 and 48 hours later.
4. Your merchant enters their information on the hosted page.
5. Check the onboarding status to see whether your merchant is verified, or which issues are still outstanding.

If your merchant's signup link expires before they complete sign-up, make a merchant association request with action reactivate and the merchantId. This extends the signup link.

Supported countries and regionsCopy Anchor Link

You can use hosted onboarding for merchants operating in the following locations.

Australia
Canada
Ireland
Mexico
New Zealand
United Kingdom
United States

API onboardingCopy Anchor Link

With API onboarding, you build the UI where you collect data from your merchants. You then send the data to Datman with the Merchants API and the KYC & Verification API:

1. Make a merchant association request with action create, and include the bankDetails, businessDetails, ownerDetails, tradingDetails and businessDealDetails objects. See Create a merchant.
2. If some details were missing, send them later with action patch. See Update merchant details.
3. Upload your merchant's KYC documents. See Upload KYC documents.
4. Check the onboarding status until your merchant is verified.

You can onboard merchants in any of the countries where Datman operates.

Next stepsCopy Anchor Link