> 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 complete 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 full lifecycle — from initial application through ongoing qualification renewals — so that merchants can programmatically manage their entire sub-merchant portfolio without manual intervention.

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 fully verified sub-merchant capable of collecting funds.
* **Track onboarding progress in real time:** Poll the Get Sub-Merchant Onboarding Status API to monitor the review lifecycle (`PROCESS → SUCCESS / FAILED`) and react programmatically when verification is complete.
* **Register sub-merchants via a lightweight report flow:** Use the Report Sub-Merchant API as a faster alternative to full onboarding for scenarios where simplified verification is sufficient, such as reporting a known supplier or platform member.
* **Monitor report review outcomes:** Query the Get Sub-Merchant Report Status API to retrieve the review decision (`TO_BE_REVIEW`, `ACTIVATED`, `AUDIT_REJECT`, `PROCESSING`) and the bank account details confirmed during the review.
* **Renew expiring qualification documents proactively:** Submit updated certificates before they lapse using the Renew Sub-Merchant Qualification API, referencing the inspection notice issued by the platform.
* **Verify the outcome of a qualification renewal:** Poll the Get Qualification Renewal Status API to confirm that renewed documents have been accepted and the sub-merchant account remains in good standing.

In essence, **Sub-Merchant Management APIs** empower you to keep your sub-merchant roster fully compliant and continuously authorized to collect funds — ensuring uninterrupted cross-border payment operations at scale.

## Endpoints

| Endpoint                                                                                                                                                     | Description                                                             |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- |
| [POST /v2/gc/sub-merchants/onboarding](/docs/global/global-collections/integration/sub-merchants/api-onboard-sub-merchant.md)                                | Submit a KYC/KYB onboarding application for a new sub-merchant.         |
| [GET /v2/gc/sub-merchants/onboarding/{requestId}](/docs/global/global-collections/integration/sub-merchants/get-sub-merchant-onboarding-status.md)           | Retrieve the status of a sub-merchant onboarding application.           |
| [POST /v2/gc/sub-merchants/report](/docs/global/global-collections/integration/sub-merchants/api-report-sub-merchant.md)                                     | Report a sub-merchant via a lighter-weight registration flow.           |
| [GET /v2/gc/sub-merchants/report/{requestId}](/docs/global/global-collections/integration/sub-merchants/get-sub-merchant-report-status.md)                   | Retrieve the status of a sub-merchant report submission.                |
| [POST /v2/gc/sub-merchants/qualification-renewals](/docs/global/global-collections/integration/sub-merchants/api-renew-qualification.md)                     | Renew an expired or expiring qualification document for a sub-merchant. |
| [GET /v2/gc/sub-merchants/qualification-renewals/{requestId}](/docs/global/global-collections/integration/sub-merchants/get-qualification-renewal-status.md) | Retrieve the status of a qualification renewal request.                 |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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://docs.neox.vn/docs/global/global-collections/integration/sub-merchants.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.