Skip to main content

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​

Mapping inserted and BCAN assigned (created is false)