brokerageDocsPage.customers
Customer Management APIs
Broker-side APIs for customer lists, account applications, review actions, ownership, online status, and customer profiles.
Authentication and access
These interfaces require an authorized broker or merchant staff session and the relevant backend permissions. They are not authenticated by an ordinary end-customer trading-app token. Confirm access with the broker administrator.
Send JSON POST requests to the selected merchant BFF environment. The Finger Admin client sends its signed-in broker-staff access token in the Authorization header as a Bearer token.
Authorization: Bearer <BROKER_STAFF_ACCESS_TOKEN>
Examples are illustrative. Replace identifiers with values from your authorized account. Response payload shapes are examples inferred from Finger Admin client usage; confirm the exact contract with your broker. Configuration and order-action requests can change live data.
Endpoints in this section
Customer records, account opening reviews, account ownership, status, and customer profile endpoints used by Finger Admin.
Customer list
Paged customer search; query keys are based on UserQueryDTO.
/mer-api/v1/customer/listRequest example
{
"page": 1,
"pageSize": 20,
"query": {
"userNumber": "",
"brokerNumber": "",
"marketType": 0,
"startTime": "",
"endTime": ""
}
}Request fields
pagenumberpageSizenumberqueryobjectResponse example
Examples are illustrative. Replace identifiers with values from your authorized account. Response payload shapes are examples inferred from Finger Admin client usage; confirm the exact contract with your broker. Configuration and order-action requests can change live data.
{
"code": 0,
"data": {
"total": 1,
"items": [
{
"id": "sample-id",
"userNumber": "U10001",
"status": 1
}
]
},
"msg": "success"
}Try this request · /mer-api/v1/customer/list
Ready. The request is not sent until you press Send.
Response—
The token is held only in this page session and is not saved by this documentation page. Avoid shared devices and clear the token when finished.
Open account applications
Paged account-opening application list.
/mer-api/v1/customer/open-account-listRequest example
{
"page": 1,
"pageSize": 20,
"query": {
"userNumber": "",
"brokerNumber": "",
"marketType": 0,
"startTime": "",
"endTime": ""
}
}Request fields
pagenumberpageSizenumberqueryobjectResponse example
Examples are illustrative. Replace identifiers with values from your authorized account. Response payload shapes are examples inferred from Finger Admin client usage; confirm the exact contract with your broker. Configuration and order-action requests can change live data.
{
"code": 0,
"data": {
"total": 1,
"items": [
{
"id": "sample-id",
"userNumber": "U10001",
"status": 1
}
]
},
"msg": "success"
}Try this request · /mer-api/v1/customer/open-account-list
Ready. The request is not sent until you press Send.
Response—
The token is held only in this page session and is not saved by this documentation page. Avoid shared devices and clear the token when finished.
Customer detail
Loads a customer record using IDDTO.
/mer-api/v1/customer/detailRequest example
{
"id": "demo-record-id"
}Request fields
idstringResponse example
Examples are illustrative. Replace identifiers with values from your authorized account. Response payload shapes are examples inferred from Finger Admin client usage; confirm the exact contract with your broker. Configuration and order-action requests can change live data.
{
"code": 0,
"data": {
"id": "sample-id",
"status": 1
},
"msg": "success"
}Try this request · /mer-api/v1/customer/detail
Ready. The request is not sent until you press Send.
Response—
The token is held only in this page session and is not saved by this documentation page. Avoid shared devices and clear the token when finished.
Open account detail
Loads account-opening application details.
/mer-api/v1/customer/get-open-detailRequest example
{
"id": "demo-record-id"
}Request fields
idstringResponse example
Examples are illustrative. Replace identifiers with values from your authorized account. Response payload shapes are examples inferred from Finger Admin client usage; confirm the exact contract with your broker. Configuration and order-action requests can change live data.
{
"code": 0,
"data": {
"id": "sample-id",
"status": 1
},
"msg": "success"
}Try this request · /mer-api/v1/customer/get-open-detail
Ready. The request is not sent until you press Send.
Response—
The token is held only in this page session and is not saved by this documentation page. Avoid shared devices and clear the token when finished.
Review account application
Submits the review decision, stage, remark, and optional failure fields.
/mer-api/v1/customer/submit-reviewRequest example
{
"id": "demo-application-id",
"approved": true,
"stageCode": "ACCOUNT_OPENING",
"proveImage": "",
"remark": "Reviewed",
"failField": {}
}Request fields
idstringapprovedbooleanstageCodestringproveImagestringremarkstringfailFieldobjectResponse example
Examples are illustrative. Replace identifiers with values from your authorized account. Response payload shapes are examples inferred from Finger Admin client usage; confirm the exact contract with your broker. Configuration and order-action requests can change live data.
{
"code": 0,
"data": true,
"msg": "success"
}Try this request · /mer-api/v1/customer/submit-review
This endpoint changes broker data or order state. Try sends a real request; it is not a simulation. Use an approved test account and environment.
Ready. The request is not sent until you press Send.
Response—
The token is held only in this page session and is not saved by this documentation page. Avoid shared devices and clear the token when finished.
Assign customer owner
Sets the customer owner/BC assignment.
/mer-api/v1/customer/set-ownerRequest example
{
"userId": "demo-user-id",
"bcId": "demo-owner-id"
}Request fields
userIdstringbcIdstringResponse example
Examples are illustrative. Replace identifiers with values from your authorized account. Response payload shapes are examples inferred from Finger Admin client usage; confirm the exact contract with your broker. Configuration and order-action requests can change live data.
{
"code": 0,
"data": true,
"msg": "success"
}Try this request · /mer-api/v1/customer/set-owner
This endpoint changes broker data or order state. Try sends a real request; it is not a simulation. Use an approved test account and environment.
Ready. The request is not sent until you press Send.
Response—
The token is held only in this page session and is not saved by this documentation page. Avoid shared devices and clear the token when finished.
Customer online status
Queries online status for a customer.
/mer-api/v1/customer/online-statusRequest example
{
"id": "demo-record-id"
}Request fields
idstringResponse example
Examples are illustrative. Replace identifiers with values from your authorized account. Response payload shapes are examples inferred from Finger Admin client usage; confirm the exact contract with your broker. Configuration and order-action requests can change live data.
{
"code": 0,
"data": {
"id": "sample-id",
"status": 1
},
"msg": "success"
}Try this request · /mer-api/v1/customer/online-status
Ready. The request is not sent until you press Send.
Response—
The token is held only in this page session and is not saved by this documentation page. Avoid shared devices and clear the token when finished.
Customer portrait overview
CustomerPortraitQueryDTO; available profile metrics depend on backend response data.
/mer-api/v1/customer/portrait/overviewRequest example
{
"id": "demo-user-id",
"startDate": "2026-01-01",
"endDate": "2026-01-31",
"marketType": 0,
"favoriteTickerLimit": 10,
"performanceOrderLimit": 20
}Request fields
idstringstartDatestringendDatestringmarketTypenumberfavoriteTickerLimitnumberperformanceOrderLimitnumberResponse example
Examples are illustrative. Replace identifiers with values from your authorized account. Response payload shapes are examples inferred from Finger Admin client usage; confirm the exact contract with your broker. Configuration and order-action requests can change live data.
{
"code": 0,
"data": {
"id": "sample-id",
"status": 1
},
"msg": "success"
}Try this request · /mer-api/v1/customer/portrait/overview
Ready. The request is not sent until you press Send.
Response—
The token is held only in this page session and is not saved by this documentation page. Avoid shared devices and clear the token when finished.
Customer order performance portrait
Queries the customer order-performance portrait.
/mer-api/v1/customer/portrait/order-performanceRequest example
{
"id": "demo-user-id",
"startDate": "2026-01-01",
"endDate": "2026-01-31",
"marketType": 0,
"favoriteTickerLimit": 10,
"performanceOrderLimit": 20
}Request fields
idstringstartDatestringendDatestringmarketTypenumberfavoriteTickerLimitnumberperformanceOrderLimitnumberResponse example
Examples are illustrative. Replace identifiers with values from your authorized account. Response payload shapes are examples inferred from Finger Admin client usage; confirm the exact contract with your broker. Configuration and order-action requests can change live data.
{
"code": 0,
"data": [
{
"date": "2026-01-01",
"orderCount": 0,
"pnl": "0"
}
],
"msg": "success"
}Try this request · /mer-api/v1/customer/portrait/order-performance
Ready. The request is not sent until you press Send.
Response—
The token is held only in this page session and is not saved by this documentation page. Avoid shared devices and clear the token when finished.