---
updatedAt: 2026-04-22T21:08:37.000Z
agentTools:
  projectIndex: https://docs.pockyt.io/llms.txt
---

# Merchant Onboarding API

Pockyt's Merchant Onboarding API enables partners to authenticate, submit, and track merchant applications efficiently via four core endpoints.

## Introduction

The Pockyt Merchant Onboarding API simplifies the merchant integration process by offering the following endpoints:

* **Get Token**: Authenticates partner credentials and returns a bearer token for secure API access.
* **Submit**: Allows partners to submit comprehensive merchant data for review and onboarding.
* **Upload Documents**: Allows partners to upload required merchant verification documents after submitting the application.
* **Query**: Enables real-time status checks of submitted merchant applications.

These APIs ensure smooth onboarding, compliance checks, and transparency across every stage of the application lifecycle.

## API Diagram

![](https://files.readme.io/8e3e6bdb3acf109c40cb341dba0d64ba344d26b9ea113c67af3e1a7587d05238-Basic_test-2026-03-15-230247.png)

## API Workflow

> 📘 API References for Workflow Steps
>
> * **Step 1:** [Get token](https://docs.pockyt.io/reference/get-token#/)
> * **Step 2:** [Submit Merchant Application](https://docs.pockyt.io/reference/submit-merchant-application#/)
> * **Step 2.1:** [Upload Merchant Onboarding Document](https://docs.pockyt.io/reference/upload-merchant-onboarding-document)
> * **Step 3:** [Query Merchant Application](https://docs.pockyt.io/reference/query-merchant-application#/)

### Step-by-step Merchant Onboarding

#### 1. **Authentication – Get Token**

Before accessing onboarding endpoints, partners must authenticate to receive a bearer token.

* **Endpoint**: `POST https://dash.yuansfer.com/api/v1/oauth2/token`
* **Body Parameters**:
  * `username` *(string, required)* – Partner account username
  * `password` *(string, required)* – Partner account password
* **Response**: Bearer token (to be used in authorization header for subsequent requests)

***

#### 2. **Submit Merchant Application – Submit**

Partners submit detailed merchant application data for onboarding.

* **Endpoint**: `POST https://dash.yuansfer.com/api/merchant-onboarding/submit`
* **Headers**:
  * `authorization: bearer <token>` (retrieved from the Get Token step)
* **Body Parameters**:
  * Merchant information: `email`, `legalName`, `dbaName`, `country`, `state`, etc.
  * Contact info: `representativeName`, `representativeLastName`, `representativeGovernmentId`, etc.
  * Ownership details: `ownerName`, `ownerPercent`, `ownerGovernmentId`, etc.
  * Banking info: `bankName`, `accountNumber`, `routingNumber`, etc.
* **Process**:
  * Submitted data is reviewed internally for compliance, risk, and financial validation.
  * Upon approval, an email is sent to both the merchant and the submitting partner with status and credentials.

Refer to the following [documentation](https://docs.pockyt.io/reference/additional-references#/) for supported country/state codes, ownership types, and ID formats.

***

#### 2.1 **Upload Merchant Documents – Upload**

Partners upload the required verification documents associated with the submitted merchant application.

* **Endpoint**: `POST https://portal.pockyt.dev/api/merchant-onboarding/upload/{merchantNo}`
* **Headers**:
  * `authorization: bearer <token>` (retrieved from the Get Token step)
* **Path Parameters**:
  * `merchantNo` (string, required): Merchant number returned from the application submission.
* **Body Parameters**:
  * file (binary, required) –Document file to upload
  * fileType (string, required) – Type of document being uploaded
  * fileName (string, required) – Custom name assigned to the uploaded document
* **Process**:
  * Uploaded documents are associated with the merchant application and used during internal compliance and onboarding review.
  * Multiple documents may be uploaded depending on the merchant verification requirements.

***

#### 3. **Track Application – Query**

Partners can query the current status of an application.

* **Endpoint**: `POST https://dash.yuansfer.com/api/merchant-onboarding/query`
* **Headers**:
  * `authorization: bearer <token>`
* **Body Parameters**:
  * `email` *(string, required)* – The email used to register the merchant
  * `partnerNo` *(string, required)* – Partner ID assigned by Pockyt
  * `referralCode` *(string, required)* – Referral code associated with fee tables
* **Response**:
  * JSON object with current application status and relevant data