Skip to content
Profile and Changes

Get Account-Opening Application Progress

Returns the current user's account-opening application under a Broker channel, including the information filled in so far, the application status, and the next step issued by the server. Use it when the user enters the account-opening flow to restore filled-in information and go to the pending step given by open_info.next_step, and on the result page to read the securities account number.

The information modules match GET /v4/member/account/open_info: v3 serves the Personal profile page and profile edit pages, while this operation serves the account-opening application flow.

It is also used at the risk assessment entry: check state to tell whether the client already has an open account, then send opened clients to the profile edit page and others to the account-opening application flow.

GEThttps://api.lbkrs.com/v4/member/account/open_info

Parameters

account_channelstringqueryRequired

Broker channel of the current account. Use account_channel returned by GET /v3/account/list.

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Account-Opening Application Progress” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
application_idinteger

Account-opening application ID

stateinteger

Account-opening application status. Values match state in GET /v3/account/list; 9 means the account is open.

client_typeinteger

Client type:

  • 1 - Individual
  • 2 - Corporate
  • 3 - Joint
Values
1
2
3
origin_idstring

Securities account number assigned after the account is opened. Used on the result page and when submitting the e-signature. Empty before the account is opened.

assets_mapobject

Map from file ID to preview URL, used to display images referenced by *_assets_id fields such as ID documents and proof of address

open_infoobject

Account-opening information grouped by module; modules that have not been filled in are omitted

Child attributes
next_stepstring

Next pending account-opening step issued by the server, for example upload (ID document upload), base (basic information), employ (employment information), finance (financial status), compliance (compliance declarations), risk (risk assessment), verify (identity verification), or signature (e-signature). Callers go to the matching step.

uploadobject

ID document module. upload holds the account-opening ID document; bcan holds the document registered for the Hong Kong Broker-to-Client Assigned Number (BCAN).

Child attributes
regionstring

Country or region code of the issuing authority

card_countrystring

Country or region code the document belongs to

card_typeinteger

ID document type code, using the same values as card_type in the account list

card_idstring

ID document number

first_namestring

Given name on the document

last_namestring

Surname on the document

valid_date_endstring

Expiry date of the document

ic_front_assets_idstring

File ID of the front image of the document

ic_back_assets_idstring

File ID of the back image of the document

bcanobject

ID document module. upload holds the account-opening ID document; bcan holds the document registered for the Hong Kong Broker-to-Client Assigned Number (BCAN).

Child attributes
regionstring

Country or region code of the issuing authority

card_countrystring

Country or region code the document belongs to

card_typeinteger

ID document type code, using the same values as card_type in the account list

card_idstring

ID document number

first_namestring

Given name on the document

last_namestring

Surname on the document

valid_date_endstring

Expiry date of the document

ic_front_assets_idstring

File ID of the front image of the document

ic_back_assets_idstring

File ID of the back image of the document

baseobject

Basic information and residential address module (base)

Child attributes
namestring

Full name

first_namestring

Given name

last_namestring

Surname

middle_namestring

Middle name

birth_datestring

Date of birth in YYYY-MM-DD format

genderstring

Gender:

  • male - Male
  • female - Female
Values
male
female
educationstring

Education level dictionary code

marital_statusstring

Marital status dictionary code

residence_countrystring

Country or region code of the residential address

residence_partstring

Province, city, and district of the residential address

residence_descstring

Street address

residence_assets_idstring

File ID of the proof of address. Look up its preview URL in assets_map in the response.

employobject

Employment and tax module (employ)

Child attributes
typestring

Employment status dictionary code, such as retired, unemployed, or homemaker

companystring

Employer name

occupationstring

Occupation dictionary code

business_typestring

Employer industry dictionary code

yearsstring

Years-of-employment dictionary code

emailstring

Contact email

address_countrystring

Country or region code of the employer address

address_partstring

Province, city, and district of the employer address

address_descstring

Employer street address

taxesarray<object>

Tax residency entries

Child attributes
countrystring

Country or region code of tax residency, such as CN or HK

idstring

Taxpayer identification number in that country or region

financeobject

Financial status module (finance)

Child attributes
estimatedstring

Net asset value range dictionary code

income_levelstring

Annual income range dictionary code

funds_sourcestring

Source-of-funds dictionary code

funds_source_otherstring

Description entered when the source of funds is “Other”

wealth_sourcestring

Source-of-wealth dictionary code

investobject

Investment experience and objectives

Child attributes
purposestring

Investment objective dictionary code

risk_tolerancestring

Risk tolerance dictionary code

stockstring

Stock investment experience dictionary code

optionstring

Options investment experience dictionary code

derivativesstring

Derivatives investment experience dictionary code

trade_timesstring

Trading frequency dictionary code

Whale Docs