Create client-ref BCAN mapping
POST{BASE_URL}/accounts/client-bcan
Inserts HKIDR CID details for a broker's underlying client under an
omnibus account and assigns a BCAN (from 10000100, CE AAB856) and a
UUID id. created is always false on insert (any value sent is
ignored) until the mapping is marked as uploaded. A duplicate
client_ref on the same account returns 400 BasicInput_Error.
hkidr_consent must be true and id_number must not be blank.
Individuals and joint accounts need at least one of
english_first_middle_name, english_last_name or chinese_name.
Other client types need english_legal_entity_name or
chinese_legal_entity_name. Text fields are trimmed;
client_type and id_type are case-insensitive. This mapping is not
linked to end_customer_id.
Request
Responses
- 201
- 400
- 401
- 403
Mapping inserted and BCAN assigned (created is false)
The request could not be accepted, for example because the account or
symbol is unavailable, a required paired account is missing, buying power
or position is insufficient, required market pricing is unavailable, an
identifier is duplicated, or an order field or requested lifecycle action
is invalid. A missing account_number, or one not linked to the API key,
also returns 400 BasicInput_Error.
Missing or invalid X-API-KEY.
The API key is read-only and the request is not a GET.