Customer

Check if customer information exists

post

version=0.0.1 bizType=customer.app.CustomerWebApiService.checkCustomerExist

Header parameters

tracestringRequired

Global link unique identifier

Example: {{mock_trace}}

companyIdstringRequired

Company ID

Example: {{company}}

versionstringRequired

Interface version number

Example: 0.0.1

Body

typeintegerRequired

Registration login method: 1 email, 2 phone number, 3 customer account

loginNamestringRequired

Account: email/phone number

phoneAreastringOptional

Mobile area code, default area code is +86

emailAreastringOptional

Email area code, default area code is +86

Responses

200Success

application/json

bizCodestringRequired

Module Identifier Code

codestringRequired

Status Return Code

msgstringOptional

Status Description

tmstringRequired

Processing Duration (milliseconds)

tracestringOptional

Tracking Code

msgParamsstringOptional

Placeholder Parameter String in Return Description, separated by commas

dataintegerOptional

1 Exists, 2 Does Not Exist

post

/customer.app.CustomerWebApiService.checkCustomerExist

POST /openapi-b/customer.app.CustomerWebApiService.checkCustomerExist HTTP/1.1
Host: pre-api-test.cmfbl.com
trace: text
companyId: text
version: text
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "type": 2,
  "loginName": "{{mock_phone}}",
  "protocol": "true",
  "emailArea": "+86",
  "phoneArea": "+86"
}

200Success

{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": "text",
  "trace": "text",
  "msgParams": "text",
  "data": 1
}

Create Account

post

Parameter: version=0.0.1 bizType=customer.admin.WhiteCustomerAdminApiService.addCusAndOpenAccountAndKyc

Header parameters

tracestringRequired

Trace Id

tokenstringRequired

Access token

versionstringRequired

Version

Example: 0.0.1

companyIdstringRequired

Company Id

Body

phonestringRequired

Mobile phone number

emailstringOptional

phoneAreastringOptional

Mobile phone area code, the default area code is +86

emailAreastringOptional

Mailbox area code, the default area code is +86

pwdstringRequired

countrystringRequired

Country: US=United States

registerSourceintegerRequired

Registration source: 1=Mobile web: H5, 2=pcweb: PC_Web, 3=System & background liquidation: System, 4=Android native app: Android, 5=Apple native app: iOS, 6=Hongmeng OS: HOS, 7=pc windows client: PC_Win, 8=pc mac client: PC_Mac, 9=not belonging to the above: other

customerGroupIdnumberRequired

Customer group ID: 1 = default customer group; customerFroupId and tradeTypeCurrencyList correspond to each other

remarkstringOptional

Remark

registerDevicestringOptional

Registered device model

utmSourcestringOptional

Advertising source (account opening link parameter source)

utmMediumstringOptional

Advertising medium (account opening link parameter medium)

utmCampaignstringOptional

Campaign (account opening link parameter campaign)

utmContentstringOptional

Ad group (account opening link parameter content)

utmTermstringOptional

Keywords (account opening link parameter term)

thirdServerCodestring · max: 50Optional

Third-party system customer unique identifier.

Responses

200Success

application/json

codestringRequired

Return Code

msgstringRequired

Return Message

bizCodestringRequired

biz code

tmnumberRequired

tracestringRequired

trace

msgParamsstring · nullableRequired

msgParams

datastringRequired

return data，customer no

post

/customer.admin.WhiteCustomerAdminApiService.addCusAndOpenAccountAndKyc

POST /openapi-b/customer.admin.WhiteCustomerAdminApiService.addCusAndOpenAccountAndKyc HTTP/1.1
Host: pre-api-test.cmfbl.com
trace: text
token: text
version: text
companyId: text
Content-Type: application/json
Accept: */*
Content-Length: 219

{
  "phone": "{{mock_phone}}",
  "pwd": "dc483e80a7a0bd9ef71d8cf973673924",
  "country": "{{national_code}}",
  "registerSource": 1,
  "customerGroupId": 1,
  "tradeTypeCurrencyList": [
    {
      "allCurrency": "USDT",
      "tradeType": "1"
    }
  ],
  "phoneArea": "+86"
}

200Success

{
  "msg": "Success",
  "fail": false,
  "trace": "t-h2jv9x-4to64-9mp4wd7-793nv-1661227305",
  "code": "0",
  "data": "86021976",
  "bizCode": "",
  "tm": 236026513,
  "msgParams": null,
  "ok": true
}

Customer basic information

post

version=0.0.1 bizType=customer.admin.WhiteCustomerAdminApiService.page

Header parameters

tracestringRequired

Global link unique identifier

Example: {{mock_trace}}

tokenstringRequired

Authentication code

Example: {{auto_token}}

versionstringRequired

Interface version number

Example: 0.0.1

companyIdstringRequired

Company ID

Example: {{company}}

Body

customerNostringRequired

Customer Number

sizenumberOptional

Number of rows displayed per page, default is 20

currentnumberOptional

Current page, default is 1

Responses

200Success

application/json

agentCustomerNostringOptional

Agent number

companyIdinteger · int64Optional

Company

createTimeinteger · int64Optional

Creation time / Application time

customerGroupIdinteger · int64Optional

Customer group Id

customerGroupNamestringOptional

Customer group name

customerNostringOptional

Customer account

customerTypeinteger · int32Optional

Customer type 0 default 1 agent 2 credit 3 activity settlement

emailstringOptional

firstAccountActivateTimeinteger · int64Optional

First activation time of trading account

firstNamestringOptional

Name

idinteger · int64Optional

idCardstringOptional

ID number

idCardTypestringOptional

ID type

lastNamestringOptional

Last name

loginTimeinteger · int64Optional

namestringOptional

First name

openAccountTypeinteger · int32Optional

Account type: 0. Individual 1. Business

phonestringOptional

Phone number

phoneAreastringOptional

Phone area code

registerSourceinteger · int32Optional

Registration source

remarkstringOptional

Remarks

statusinteger · int32Optional

Status: 1. Normal, 2. Disabled, 3. Deleted, 4. Closed account, 5. Locked, 6. Closing account

tgUserIdstringOptional

tgUserId

tgUserNamestringOptional

tgUserName

thirdAccountNostringOptional

Third-party account

thirdLoginSourcestringOptional

thirdLoginSource

thirdUserIdstringOptional

thirdUserId

unitIdinteger · int64Optional

Institution ID

unitNamestringOptional

Institution name

updateTimeinteger · int64Optional

Update time

post

/customer.admin.WhiteCustomerAdminApiService.page

POST /openapi-b/customer.admin.WhiteCustomerAdminApiService.page HTTP/1.1
Host: pre-api-test.cmfbl.com
trace: text
token: text
version: text
companyId: text
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "customerNo": null,
  "size": 20,
  "current": 1
}

200Success

{
  "bizCode": "",
  "code": "",
  "data": {
    "current": 0,
    "records": [
      {
        "agentCustomerNo": "",
        "companyId": 0,
        "createTime": 0,
        "customerGroupId": 0,
        "customerGroupName": "",
        "customerNo": "",
        "customerType": 0,
        "email": "",
        "firstAccountActivateTime": 0,
        "firstName": "",
        "id": 0,
        "idCard": "",
        "idCardType": "",
        "lastName": "",
        "loginTime": 0,
        "name": "",
        "openAccountType": 0,
        "phone": "",
        "phoneArea": "",
        "registerSource": 0,
        "remark": "",
        "status": 0,
        "tgUserId": "",
        "tgUserName": "",
        "thirdAccountNo": "",
        "thirdLoginSource": "",
        "thirdUserId": "",
        "unitId": 0,
        "unitName": "",
        "updateTime": 0
      }
    ],
    "size": 0,
    "total": 0
  },
  "fail": true,
  "msg": "",
  "msgParams": "",
  "ok": true,
  "tm": 0,
  "trace": ""
}

Customer details

post

version=0.0.1 bizType=customer.admin.WhiteCustomerAdminApiService.detail

Header parameters

tracestringRequired

Global link unique identifier

Example: {{mock_trace}}

tokenstringRequired

Authentication code

Example: {{auto_token}}

versionstringRequired

Interface version number

Example: 0.0.1

companyIdstringRequired

Company ID

Example: {{company}}

Body

typestringRequired

Type information, baseInfo= basic information, tradeAccount= trading account, kyc= kyc information, allKyc= detailed kyc information on the page, bankList= bank card list, walletList= wallet address, otherInfo= other

idstringRequired

Customer ID

customerNostringRequired

Customer Number

Responses

200Success

application/json

accountListobjectOptional

Trading account list

accountRemarkstringOptional

Whether the customer has a trading account note

activateStatusinteger · int32Optional

Activation status

activateTimeinteger · int64Optional

Activation time

addressstringOptional

Mailing address

apiCheckRulestringOptional

API verification rules. 1- email; 2- SMS; 3- Google NFA; enable multiple verifications at the same time, separated by commas.

apiCheckSwitchbooleanOptional

API verification switch

assertPassStatusstringOptional

Set fund password reminder flag, 1 requires setting password, 2 does not require

associationCompanyIdinteger · int64Optional

Associated company Id

companyIdinteger · int64Optional

Company

companyKycStatusinteger · int32Optional

Company KYC account opening status, 1 open 2 not open

companyTypestringOptional

Company type

countrystringOptional

Country

createTimeinteger · int64Optional

Creation time

customerAgentMarkstringOptional

Customer agent identifier

customerGroupIdinteger · int64Optional

Customer group

customerNostringOptional

Customer account

customerTypeinteger · int32Optional

Customer type 0 default 1 agent 2 credit 3 activity settlement

depositinteger · int32Optional

Can deposit, 1 can deposit

earlyWarningLevelobjectOptional

Warning level

emailstringOptional

firstNamestringOptional

Name

forceLevelobjectOptional

Force liquidation level

googleIdinteger · int64Optional

Whether to enable MFA, greater than 0, enable, otherwise not enable

idinteger · int64Optional

Customer ID

idCardstringOptional

ID number

idCardTypestringOptional

ID type

isFundinteger · int32Optional

Whether it is a fund manager, 1 is, default 0 is not

kycAuditRemarkstringOptional

Registration KYC review remarks, review rejection is not empty

kycAuditStatusinteger · int32Optional

Registration KYC review status: 0 not certified redirect to certification page, 1 pending review, 2 review passed, 3 review failed

kycRemarkstringOptional

KYC status name

kycStatusinteger · int32Optional

KYC status

lastNamestringOptional

Last name

loginPassStatusstringOptional

Set password reminder flag, 1 requires setting password, 2 does not require

loginTimeinteger · int64Optional

namestringOptional

First name

openAccountTypeinteger · int32Optional

Account type: 0. Individual 1. Business

optionalinteger · int32Optional

Optional flag 0 not added 1 added

payPassStatusstringOptional

Payment password existence status, 1 does not exist, 2 exists

phonestringOptional

Phone number

phoneAreastringOptional

Phone area code

postalCodestringOptional

Postal code

registerSourceinteger · int32Optional

Registration source

registerTimeinteger · int64Optional

Registration time

relationCustomerIdinteger · int64Optional

Associated account id

sourcestringOptional

Source

statusinteger · int32Optional

Status: 1. Normal, 2. Disabled, 3. Deleted, 4. Closed account, 5. Locked, 6. Closing account

thirdIntactMsgstringOptional

Third-party login complete data

thirdLoginSourcestringOptional

Third-party login source google, facebook, twitter

thirdServerCodestringOptional

Third-party system unique identifier

thirdUserIdstringOptional

Third-party userId

typeinteger · int32Optional

Group type <0 real, 1 simulated, 2 visitor>

unitIdinteger · int64Optional

Institution ID

unitNamestringOptional

Institution name

utmSourcestringOptional

Ad source

withdrawinteger · int32Optional

Withdrawable, 1 withdrawable

withdrawLevelobjectOptional

Withdrawal level

post

/customer.admin.WhiteCustomerAdminApiService.detail

POST /openapi-b/customer.admin.WhiteCustomerAdminApiService.detail HTTP/1.1
Host: pre-api-test.cmfbl.com
trace: text
token: text
version: text
companyId: text
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "type": "tradeAccount",
  "id": "{{customerId}}",
  "customerNo": "{{customer}}"
}

200Success

{
  "bizCode": "",
  "code": "",
  "data": {
    "accountList": {},
    "accountRemark": "",
    "activateStatus": 0,
    "activateTime": 0,
    "address": "",
    "apiCheckRule": "",
    "apiCheckSwitch": true,
    "assertPassStatus": "",
    "associationCompanyId": 0,
    "companyId": 0,
    "companyKycStatus": 0,
    "companyType": "",
    "country": "",
    "createTime": 0,
    "customerAgentMark": "",
    "customerGroupId": 0,
    "customerNo": "",
    "customerType": 0,
    "deposit": 0,
    "earlyWarningLevel": {},
    "email": "",
    "firstName": "",
    "forceLevel": {},
    "googleId": 0,
    "id": 0,
    "idCard": "",
    "idCardType": "",
    "isFund": 0,
    "kycAuditRemark": "",
    "kycAuditStatus": 0,
    "kycRemark": "",
    "kycStatus": 0,
    "lastName": "",
    "loginPassStatus": "",
    "loginTime": 0,
    "name": "",
    "openAccountType": 0,
    "optional": 0,
    "payPassStatus": "",
    "phone": "",
    "phoneArea": "",
    "postalCode": "",
    "registerSource": 0,
    "registerTime": 0,
    "relationCustomerId": 0,
    "source": "",
    "status": 0,
    "thirdIntactMsg": "",
    "thirdLoginSource": "",
    "thirdServerCode": "",
    "thirdUserId": "",
    "type": 0,
    "unitId": 0,
    "unitName": "",
    "utmSource": "",
    "withdraw": 0,
    "withdrawLevel": {}
  },
  "fail": true,
  "msg": "",
  "msgParams": "",
  "ok": true,
  "tm": 0,
  "trace": ""
}

Check customer group list

post

version=0.0.1 bizType=customer.admin.CustomerGroupAdminApiService.groupList Accessible after B-side authentication

Header parameters

tracestringRequired

Global link unique identifier

Example: {{mock_trace}}

companyIdstringRequired

Company ID

Example: {{company}}

tokenstringRequired

Token after B-end authentication

Example: {{auto_token}}

versionstringRequired

Interface version number

Example: 0.0.1

Body

objectOptional

Responses

200Success

application/json

bizCodestringOptional

Module identifier code

codestringOptional

Status return code

msgstringOptional

Status description

tminteger · int64Optional

Processing time (milliseconds)

tracestringOptional

Tracking code

msgParamsstringOptional

Placeholder parameter string in return description, multiple parameters separated by commas

okbooleanOptional

failbooleanOptional

post

/customer.admin.CustomerGroupAdminApiService.groupList

POST /openapi-b/customer.admin.CustomerGroupAdminApiService.groupList HTTP/1.1
Host: pre-api-test.cmfbl.com
trace: text
companyId: text
token: text
version: text
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "tradeType": 5,
  "customerNo": "86000020"
}

200Success

{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "data": {
    "id": 1,
    "name": "text",
    "openAccountType": 1,
    "type": 1,
    "tradeType": 1,
    "assets": "text"
  },
  "ok": true,
  "fail": true
}

PreviousFund NextMessage

Last updated 3 months ago

hashtagCheck if customer information exists

hashtagCreate Account

hashtagCustomer basic information

hashtagCustomer details

hashtagCheck customer group list

Check if customer information exists

Create Account

Customer basic information

Customer details

Check customer group list