> For the complete documentation index, see [llms.txt](https://docs.neox.vn/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.neox.vn/docs/global/global-collections/integration/sub-merchants.md).

# Sub-Merchant Management APIs

**Sub-Merchant Management APIs** provide a set of operations for registering, verifying, and maintaining the compliance status of sub-merchants on the NeoX Global Collections platform. Before any seller or service provider can receive funds through the platform, they must be onboarded as a KYC/KYB-verified sub-merchant. These APIs cover the sub-merchant lifecycle — from initial application, through updates and qualification supplements, to status lookup.

By integrating with these APIs, organizations can:

* **Onboard sub-merchants with full KYC/KYB verification:** Submit complete company registration details, key personnel records, and supporting documents through the Onboard Sub-Merchant API to create a sub-merchant record.
* **Update sub-merchant information:** Modify previously submitted fields via the Update Sub-Merchant Info action, without resubmitting the full application.
* **Look up sub-merchant detail and status:** Query the Get Sub-Merchant Detail / Onboarding Status API by `requestId` to retrieve the full record, including its current status.
* **Submit qualification supplements/renewals:** Submit updated certificates in response to an inspection notice using the Renew Sub-Merchant Qualification API.
* **Check qualification supplement status:** Query the Get Qualification Renewal Status API — note this endpoint currently has a documented known limitation (see its page).

{% hint style="info" %}
There is no lightweight "Report Sub-Merchant" flow in the current backend. See the notices on the corresponding pages below.
{% endhint %}

## Endpoints

| Endpoint                                                                                                                                   | Description                                                                                                                   |
| ------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
| [POST /v2/gc/sub-merchants/onboard](/docs/global/global-collections/integration/sub-merchants/api-onboard-sub-merchant.md)                 | Submit a KYC/KYB onboarding application for a new sub-merchant.                                                               |
| [PUT /v2/gc/sub-merchants](/docs/global/global-collections/integration/sub-merchants/api-onboard-sub-merchant.md#update-sub-merchant-info) | Update fields on a previously submitted sub-merchant record.                                                                  |
| [GET /v2/gc/sub-merchants](/docs/global/global-collections/integration/sub-merchants/get-sub-merchant-onboarding-status.md)                | Retrieve the full detail record and status of a sub-merchant by `requestId`.                                                  |
| [POST /v2/gc/sub-merchants/qualification/supplement](broken://pages/KwFUxrvz1pZ7srSQijBx)                                                  | Submit a qualification supplement/renewal document for a sub-merchant.                                                        |
| [GET /v2/gc/sub-merchants/qualification/supplement/status](broken://pages/X0oGIeCmPjmrkwdgcnrB)                                            | Retrieve the status of a qualification supplement request (known limitation: not yet synced with the upstream KYC processor). |