Skip to content
My Broker

Create/Modify My Broker Info

Creates or edits an own-side broker record (currently V3). Passing id performs an edit; otherwise a new record is created.

Request parameters

  • Required: market (market), code (broker code), name (channel broker name), company_name (counter company name), contact (contact person), contact_email (contact email), contact_phones (contact phones)
  • Optional: id (broker record ID), account (broker account), audit_frontend_resource (caller-provided audit context)
  • See the field descriptions for the format, value range, and business meaning of each field.

Business notes

Own-side brokers identify this firm's broker and counter contact information per market for use in transfer and related business.

Risk warning

This operation changes live broker configuration data. Confirm the target record and parameters before calling.

Result

On success, the broker record is created or edited. The resulting state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/atm/create_modify_brokers_my_v3

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

cmbc.broker_my

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

idstring

Broker Record ID. Provided only when editing an existing record; not sent when creating.

marketstringrequired

Market. Dropdown selection. This field is disabled and cannot be modified when editing.

Allowed values: us US market, cn Shanghai/Shenzhen market, hk Hong Kong market, sg Singapore market

Values
us
US Market
cn
CN Market
hk
HK Market
sg
SG Market
codestringrequired

Code. Specifies Code. This field is required.

namestringrequired

Name of channel broker. Specifies Name of channel broker. This field is required.

company_namestringrequired

Name of Counter Company. Specifies Name of Counter Company. This field is required.

accountstring

Broker Account. Specifies Broker Account.

contactstringrequired

Contact. Specifies Contact. This field is required.

contact_emailstringrequired

Contact Email. Specifies Contact Email. This field is required.

contact_phonesarray<object>required

Contact Phone. An array of { contact_phone: string }; multiple contact phones can be added or removed dynamically, and each must match the regex ^[A-Za-z0-9,.-+\s]+$.

Child attributes
contact_phonestring

Contact phone number.

audit_frontend_resourceobject

Audit Context. An audit-trail field automatically appended by the client, containing $action/$behavior and the original field values prior to editing; not a business parameter.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs