Skip to content
Longport WhaleLongport Whale
File Rules

Create OB File Member

Create an OB file member configuration.

Request parameters

  • Required: member_id (member ID), org_account_channel (organization account channel), status (configuration status), op_email (operator email)
  • Optional: remark (remark), audit_frontend_resource (caller-provided audit context)
  • See each field description for format, value range, and business meaning.

Business notes

Creates an OB file member configuration for member_id and the given org_account_channel; status controls whether the configuration is enabled.

Result

On success the member configuration is created; refer to the 200 response for the resulting state and returned data.

POSThttps://b-api.lbkrs.com/ob_file/create_member

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.ob_file_rule_operation

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

Request body application/json

member_idstringrequired

Member ID associated with this request.

member_id is the customer ID. It differs from the securities account number account_no and the internal securities account ID aaid; one customer can have multiple securities accounts.

org_account_channelstringrequired

This field is required.

statusnumberrequired

Target state to set through this request. This field is required.

Allowed values: 0 Close, 1 Open, 2 Deregister

Values
0
Close
1
Open
2
Deregister
remarkstring
op_emailstringrequired

This field is required.

audit_frontend_resourceobject

Provides audit context for this operation.

Responses

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

On success data is an empty object.

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