# Onboarding

The primary method for onboarding new sub-merchants is through our **Referral Signup Link**.

Once your platform is eligible, your account manager will provide a unique URL. You should present this link to the clients you wish to onboard as sub-merchants.

When your client uses this link, the form will:

* [x] Collect all the necessary information to create their merchant account.
* [x] Automatically apply all required configurations for them to start processing payments.

The form is mobile-responsive and can be embedded directly into your platform using an `iframe` for a seamless user experience.

### Matching Submerchants with your system

To easily track and match a new sub-merchant with the corresponding user in your own system, you can add a **query parameter** to the referral URL.

Append the **`externalSubMerchantId`** parameter to the end of the URL you received, using your internal identifier for that user.

Format:

**`&externalSubMerchantId=`**`{YourUniqueSubMerchantID}`

Example: If your referral URL is `https://example.onekeypayments.com/referral?id=XYZ123` and your internal user ID is `user-9876`, the final URL would be:

`https://example.onekeypayments.com/referral?id=XYZ123&`**`externalSubMerchantId=user-9876`**

### Onboarding confirmation

After a submerchant successfully completes the signup form, you will receive a webhook <a href="/pages/uxu9FJQv9Ij8XlFrTcWt" class="button primary" data-icon="message-medical">Notification</a> confirming that their account has been created.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidocs.onekeypayments.com/guides/platforms-booster/onboarding.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
