> For the complete documentation index, see [llms.txt](https://docs.multimarkets.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.multimarkets.org/manager-api/more.../customer.md). # Customer ## Check if customer information exists > version=0.0.1\ > bizType=customer.app.CustomerWebApiService.checkCustomerExist ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer"}],"servers":[{"url":"https://pre-api-test.cmfbl.com/openapi-b","description":"PRE环境-公司439"}],"security":[],"paths":{"/customer.app.CustomerWebApiService.checkCustomerExist":{"post":{"summary":"Check if customer information exists","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.CustomerWebApiService.checkCustomerExist","tags":["Customer"],"parameters":[{"name":"trace","in":"header","description":"Global link unique identifier","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"version","in":"header","description":"Interface version number","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"integer","description":"Registration login method: 1 email, 2 phone number, 3 customer account"},"loginName":{"type":"string","description":"Account: email/phone number"},"phoneArea":{"type":"string","description":"Mobile area code, default area code is +86"},"emailArea":{"type":"string","description":"Email area code, default area code is +86"}},"required":["type","loginName"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"Module Identifier Code","description":"Module Identifier Code"},"code":{"type":"string","title":"Status Return Code","description":"Status Return Code"},"msg":{"type":"string","title":"Status Description","description":"Status Description"},"tm":{"type":"string","title":"Processing Duration (milliseconds)","description":"Processing Duration (milliseconds)"},"trace":{"type":"string","title":"Tracking Code","description":"Tracking Code"},"msgParams":{"type":"string","title":"Placeholder Parameter String in Return Description, separated by commas","description":"Placeholder Parameter String in Return Description, separated by commas"},"data":{"type":"integer","title":"1 Exists, 2 Does Not Exist","description":"1 Exists, 2 Does Not Exist"}},"required":["bizCode","code","tm"]}}},"headers":{}}}}}}} ``` ## Create Account > Parameter:\ > version=0.0.1\ > bizType=customer.admin.WhiteCustomerAdminApiService.addCusAndOpenAccountAndKyc ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer"}],"servers":[{"url":"https://pre-api-test.cmfbl.com/openapi-b","description":"PRE环境-公司439"}],"security":[],"paths":{"/customer.admin.WhiteCustomerAdminApiService.addCusAndOpenAccountAndKyc":{"post":{"summary":"Create Account","deprecated":false,"description":"Parameter:\nversion=0.0.1\nbizType=customer.admin.WhiteCustomerAdminApiService.addCusAndOpenAccountAndKyc","tags":["Customer"],"parameters":[{"name":"trace","in":"header","description":"Trace Id","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Access token","required":true,"schema":{"type":"string"}},{"name":"version","in":"header","description":"Version","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string","description":"Mobile phone number"},"email":{"type":"string","description":"Email"},"phoneArea":{"type":"string","description":"Mobile phone area code, the default area code is +86"},"emailArea":{"type":"string","description":"Mailbox area code, the default area code is +86"},"pwd":{"type":"string","description":"Login password, MD5 encryption, a123456"},"country":{"type":"string","description":"Country: US=United States"},"registerSource":{"type":"integer","description":"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"},"customerGroupId":{"type":"number","description":"Customer group ID: 1 = default customer group; customerFroupId and tradeTypeCurrencyList correspond to each other"},"remark":{"type":"string","description":"Remark"},"registerDevice":{"type":"string","description":"Registered device model"},"utmSource":{"type":"string","description":"Advertising source (account opening link parameter source)"},"utmMedium":{"type":"string","description":"Advertising medium (account opening link parameter medium)"},"utmCampaign":{"type":"string","description":"Campaign (account opening link parameter campaign)"},"utmContent":{"type":"string","description":"Ad group (account opening link parameter content)"},"utmTerm":{"type":"string","description":"Keywords (account opening link parameter term)"},"thirdServerCode":{"type":"string","maxLength":50,"description":"Third-party system customer unique identifier."}},"required":["phone","country","customerGroupId","registerSource","pwd"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Return Code"},"msg":{"type":"string","description":"Return Message"},"bizCode":{"type":"string","description":"biz code"},"tm":{"description":"tm","type":"number"},"trace":{"type":"string","description":"trace"},"msgParams":{"description":"msgParams","type":"string","nullable":true},"data":{"type":"string","description":"return data，customer no"}},"required":["code","msg","bizCode","tm","trace","msgParams","data"]}}},"headers":{}}}}}}} ``` ## Customer basic information > version=0.0.1\ > bizType=customer.admin.WhiteCustomerAdminApiService.page ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer"}],"servers":[{"url":"https://pre-api-test.cmfbl.com/openapi-b","description":"PRE环境-公司439"}],"security":[],"paths":{"/customer.admin.WhiteCustomerAdminApiService.page":{"post":{"summary":"Customer basic information","deprecated":false,"description":"version=0.0.1\nbizType=customer.admin.WhiteCustomerAdminApiService.page","tags":["Customer"],"parameters":[{"name":"trace","in":"header","description":"Global link unique identifier","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Authentication code","required":true,"schema":{"type":"string"}},{"name":"version","in":"header","description":"Interface version number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customerNo":{"type":"string","description":"Customer Number"},"size":{"type":"number","description":"Number of rows displayed per page, default is 20"},"current":{"type":"number","description":"Current page, default is 1"}},"required":["customerNo"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"agentCustomerNo":{"type":"string","description":"Agent number","refType":null},"companyId":{"type":"integer","format":"int64","description":"Company","refType":null},"createTime":{"type":"integer","format":"int64","description":"Creation time / Application time","refType":null},"customerGroupId":{"type":"integer","format":"int64","description":"Customer group Id","refType":null},"customerGroupName":{"type":"string","description":"Customer group name","refType":null},"customerNo":{"type":"string","description":"Customer account","refType":null},"customerType":{"type":"integer","format":"int32","description":"Customer type 0 default 1 agent 2 credit 3 activity settlement","refType":null},"email":{"type":"string","description":"Email","refType":null},"firstAccountActivateTime":{"type":"integer","format":"int64","description":"First activation time of trading account","refType":null},"firstName":{"type":"string","description":"Name","refType":null},"id":{"type":"integer","format":"int64","description":"id","refType":null},"idCard":{"type":"string","description":"ID number","refType":null},"idCardType":{"type":"string","description":"ID type","refType":null},"lastName":{"type":"string","description":"Last name","refType":null},"loginTime":{"type":"integer","format":"int64","description":"Login time","refType":null},"name":{"type":"string","description":"First name","refType":null},"openAccountType":{"type":"integer","format":"int32","description":"Account type: 0. Individual 1. Business ","refType":null},"phone":{"type":"string","description":"Phone number","refType":null},"phoneArea":{"type":"string","description":"Phone area code","refType":null},"registerSource":{"type":"integer","format":"int32","description":"Registration source","refType":null},"remark":{"type":"string","description":"Remarks","refType":null},"status":{"type":"integer","format":"int32","description":"Status: 1. Normal, 2. Disabled, 3. Deleted, 4. Closed account, 5. Locked, 6. Closing account","refType":null},"tgUserId":{"type":"string","description":"tgUserId","refType":null},"tgUserName":{"type":"string","description":"tgUserName","refType":null},"thirdAccountNo":{"type":"string","description":"Third-party account","refType":null},"thirdLoginSource":{"type":"string","description":"thirdLoginSource","refType":null},"thirdUserId":{"type":"string","description":"thirdUserId","refType":null},"unitId":{"type":"integer","format":"int64","description":"Institution ID","refType":null},"unitName":{"type":"string","description":"Institution name","refType":null},"updateTime":{"type":"integer","format":"int64","description":"Update time","refType":null}},"title":"WhiteCustomerAdminPageVO"}}},"headers":{}}}}}}} ``` ## Customer details > version=0.0.1\ > bizType=customer.admin.WhiteCustomerAdminApiService.detail ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer"}],"servers":[{"url":"https://pre-api-test.cmfbl.com/openapi-b","description":"PRE环境-公司439"}],"security":[],"paths":{"/customer.admin.WhiteCustomerAdminApiService.detail":{"post":{"summary":"Customer details","deprecated":false,"description":"version=0.0.1\nbizType=customer.admin.WhiteCustomerAdminApiService.detail","tags":["Customer"],"parameters":[{"name":"trace","in":"header","description":"Global link unique identifier","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Authentication code","required":true,"schema":{"type":"string"}},{"name":"version","in":"header","description":"Interface version number","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"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"},"id":{"type":"string","description":"Customer ID"},"customerNo":{"type":"string","description":"Customer Number"}},"required":["type","id","customerNo"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"accountList":{"type":"object","description":"Trading account list","refType":null,"properties":{}},"accountRemark":{"type":"string","description":"Whether the customer has a trading account note","refType":null},"activateStatus":{"type":"integer","format":"int32","description":"Activation status","refType":null},"activateTime":{"type":"integer","format":"int64","description":"Activation time","refType":null},"address":{"type":"string","description":"Mailing address","refType":null},"apiCheckRule":{"type":"string","description":"API verification rules. 1- email; 2- SMS; 3- Google NFA; enable multiple verifications at the same time, separated by commas.","refType":null},"apiCheckSwitch":{"type":"boolean","description":"API verification switch","refType":null},"assertPassStatus":{"type":"string","description":"Set fund password reminder flag, 1 requires setting password, 2 does not require","refType":null},"associationCompanyId":{"type":"integer","format":"int64","description":"Associated company Id","refType":null},"companyId":{"type":"integer","format":"int64","description":"Company","refType":null},"companyKycStatus":{"type":"integer","format":"int32","description":"Company KYC account opening status, 1 open 2 not open","refType":null},"companyType":{"type":"string","description":"Company type","refType":null},"country":{"type":"string","description":"Country","refType":null},"createTime":{"type":"integer","format":"int64","description":"Creation time","refType":null},"customerAgentMark":{"type":"string","description":"Customer agent identifier","refType":null},"customerGroupId":{"type":"integer","format":"int64","description":"Customer group","refType":null},"customerNo":{"type":"string","description":"Customer account","refType":null},"customerType":{"type":"integer","format":"int32","description":"Customer type 0 default 1 agent 2 credit 3 activity settlement","refType":null},"deposit":{"type":"integer","format":"int32","description":"Can deposit, 1 can deposit","refType":null},"earlyWarningLevel":{"type":"object","description":"Warning level","refType":null,"properties":{}},"email":{"type":"string","description":"Email","refType":null},"firstName":{"type":"string","description":"Name","refType":null},"forceLevel":{"type":"object","description":"Force liquidation level","refType":null,"properties":{}},"googleId":{"type":"integer","format":"int64","description":"Whether to enable MFA, greater than 0, enable, otherwise not enable","refType":null},"id":{"type":"integer","format":"int64","description":"Customer ID","refType":null},"idCard":{"type":"string","description":"ID number","refType":null},"idCardType":{"type":"string","description":"ID type","refType":null},"isFund":{"type":"integer","format":"int32","description":"Whether it is a fund manager, 1 is, default 0 is not","refType":null},"kycAuditRemark":{"type":"string","description":"Registration KYC review remarks, review rejection is not empty","refType":null},"kycAuditStatus":{"type":"integer","format":"int32","description":"Registration KYC review status: 0 not certified redirect to certification page, 1 pending review, 2 review passed, 3 review failed","refType":null},"kycRemark":{"type":"string","description":"KYC status name","refType":null},"kycStatus":{"type":"integer","format":"int32","description":"KYC status","refType":null},"lastName":{"type":"string","description":"Last name","refType":null},"loginPassStatus":{"type":"string","description":"Set password reminder flag, 1 requires setting password, 2 does not require","refType":null},"loginTime":{"type":"integer","format":"int64","description":"Login time","refType":null},"name":{"type":"string","description":"First name","refType":null},"openAccountType":{"type":"integer","format":"int32","description":"Account type: 0. Individual 1. Business ","refType":null},"optional":{"type":"integer","format":"int32","description":"Optional flag 0 not added 1 added","refType":null},"payPassStatus":{"type":"string","description":"Payment password existence status, 1 does not exist, 2 exists","refType":null},"phone":{"type":"string","description":"Phone number","refType":null},"phoneArea":{"type":"string","description":"Phone area code","refType":null},"postalCode":{"type":"string","description":"Postal code","refType":null},"registerSource":{"type":"integer","format":"int32","description":"Registration source","refType":null},"registerTime":{"type":"integer","format":"int64","description":"Registration time","refType":null},"relationCustomerId":{"type":"integer","format":"int64","description":"Associated account id","refType":null},"source":{"type":"string","description":"Source","refType":null},"status":{"type":"integer","format":"int32","description":"Status: 1. Normal, 2. Disabled, 3. Deleted, 4. Closed account, 5. Locked, 6. Closing account","refType":null},"thirdIntactMsg":{"type":"string","description":"Third-party login complete data","refType":null},"thirdLoginSource":{"type":"string","description":"Third-party login source google, facebook, twitter","refType":null},"thirdServerCode":{"type":"string","description":"Third-party system unique identifier","refType":null},"thirdUserId":{"type":"string","description":"Third-party userId","refType":null},"type":{"type":"integer","format":"int32","description":"Group type <0 real, 1 simulated, 2 visitor>","refType":null},"unitId":{"type":"integer","format":"int64","description":"Institution ID","refType":null},"unitName":{"type":"string","description":"Institution name","refType":null},"utmSource":{"type":"string","description":"Ad source","refType":null},"withdraw":{"type":"integer","format":"int32","description":"Withdrawable, 1 withdrawable","refType":null},"withdrawLevel":{"type":"object","description":"Withdrawal level","refType":null,"properties":{}}},"title":"CustomerAllInfoVO"}}},"headers":{}}}}}}} ``` ## Check customer group list > version=0.0.1\ > bizType=customer.admin.CustomerGroupAdminApiService.groupList\ > Accessible after B-side authentication ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer"}],"servers":[{"url":"https://pre-api-test.cmfbl.com/openapi-b","description":"PRE环境-公司439"}],"security":[],"paths":{"/customer.admin.CustomerGroupAdminApiService.groupList":{"post":{"summary":"Check customer group list","deprecated":false,"description":"version=0.0.1\nbizType=customer.admin.CustomerGroupAdminApiService.groupList\nAccessible after B-side authentication","tags":["Customer"],"parameters":[{"name":"trace","in":"header","description":"Global link unique identifier","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"header","description":"Company ID","required":true,"schema":{"type":"string"}},{"name":"token","in":"header","description":"Token after B-end authentication","required":true,"schema":{"type":"string"}},{"name":"version","in":"header","description":"Interface version number","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","description":"Module identifier code"},"code":{"type":"string","description":"Status return code"},"msg":{"type":"string","description":"Status description"},"tm":{"type":"integer","format":"int64","description":"Processing time (milliseconds)"},"trace":{"type":"string","description":"Tracking code"},"msgParams":{"type":"string","description":"Placeholder parameter string in return description, multiple parameters separated by commas"},"data":{"type":"object","description":"Data body","properties":{"id":{"type":"integer","description":"Customer group ID"},"name":{"type":"string","description":"Customer group name"},"openAccountType":{"type":"integer","description":"Is it an opening group, 1 for yes, 0 for no"},"type":{"type":"integer","description":"Customer group type, 0 for real, 1 for test, 2 for guest"},"tradeType":{"type":"integer","description":"Gameplay ID"},"assets":{"type":"string","description":"Asset information"}},"required":["tradeType","assets"]},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}}} ```