> 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/client-api/more.../customer-kyc.md). # Customer/KYC ## Is the business scenario KYC approved? > version=0.0.1\ > bizType=customer.app.KycWebApiService.checkKycApply\ > Can access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/KYC"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.KycWebApiService.checkKycApply":{"post":{"summary":"Is the business scenario KYC approved?","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.KycWebApiService.checkKycApply\nCan access after login","operationId":"checkKycApply","tags":["Customer/KYC"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"openAccountType":{"type":"integer","format":"int32","description":"Account type: 0. Individual 1. Enterprise "},"businessCode":{"type":"string","description":"Business scenario code, account opening=open_account, deposit=cashin, withdrawal=withdraw, credit card=apply_credit_card"}},"required":["businessCode"]}}}},"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":"KYC rejection reason"},"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":"integer","description":"Normal 2=success, abnormal status [0 authentication, 1 under review, 3 review rejection]"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}}} ``` ## Get KYC authentication information for business scenarios > version=0.0.1\ > bizType=customer.app.KycWebApiService.findAllBizKyc\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/KYC"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.KycWebApiService.findAllBizKyc":{"post":{"summary":"Get KYC authentication information for business scenarios","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.KycWebApiService.findAllBizKyc\nAccessible after login","operationId":"findAllBizKyc","tags":["Customer/KYC"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"businessCode":{"type":"string","description":"Business scenario code, account opening=open_account, deposit=cashin, withdrawal=withdraw, credit card=apply_credit_card"},"openAccountType":{"type":"integer","format":"int32","description":"Account type: 0. Individual 1. Enterprise"}},"required":["businessCode"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListKycAuthVO"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResultListKycAuthVO":{"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":"array","description":"Data Body","items":{"$ref":"#/components/schemas/KycAuthVO"}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"KycAuthVO":{"type":"object","properties":{"levelCode":{"type":"string","description":"Level Code"},"openAccountType":{"type":"integer","format":"int32","description":"Account type: 0. Individual 1. Enterprise "},"levelName":{"type":"string","description":"Level Name"},"pathName":{"type":"string","description":"KYC Path Name"},"pathCode":{"type":"string","description":"KYC Path Code"},"elementList":{"type":"array","description":"KYC Information List","items":{"$ref":"#/components/schemas/KycAuthElementVO"}}}},"KycAuthElementVO":{"type":"object","properties":{"elementCode":{"type":"string","description":"KYC element code"},"elementName":{"type":"string","description":"KYC element name"},"showType":{"type":"string","description":"KYC element display type"},"extend":{"type":"string","description":"KYC element extended attribute"},"elementValue":{"type":"string","description":"KYC element value"},"elementValueInputGroup":{"type":"string","description":"KYC element value, combination"},"elementCodeInputGroup":{"type":"string","description":"KYC element code, combination"}}}}}} ``` ## Identity authentication list > version=0.0.1\ > bizType=customer.app.KycWebApiService.findAllBizKycList\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/KYC"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.KycWebApiService.findAllBizKycList":{"post":{"summary":"Identity authentication list","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.KycWebApiService.findAllBizKycList\nAccessible after login","operationId":"findAllBizKycList","tags":["Customer/KYC"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"openAccountType":{"type":"integer","format":"int32","description":"Account type: 0. Individual 1. Enterprise "}}}}}},"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":"array","description":"Data Body","items":{"type":"object","properties":{"levelCode":{"type":"string","description":"KYC level code"},"levelName":{"type":"string","description":"KYC level name"},"status":{"type":"integer","format":"int32","description":"Authentication status, 0-authenticated, 1-under review, 2-approved, 3-rejected"},"statusName":{"type":"string","description":"Authentication status name, 0-authenticated, 1-under review, 2-approved, 3-rejected"},"sort":{"type":"integer","format":"int32","description":"Sort"},"preLevelName":{"type":"string","description":"Preceding Level Information"},"businessNameList":{"type":"array","description":"Business Scenario Name Collection","uniqueItems":true,"items":{"type":"string"}},"businessCodeList":{"type":"array","items":{"type":"string"},"description":"Business Scenario Code Collection"},"companyType":{"type":"string","description":"Enterprise Type "},"openAccountType":{"type":"string","description":"Account type: 0. Individual 1. Enterprise "},"pathCode":{"type":"string","description":"Authentication Path"}}}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}}} ``` ## Get customer's authenticated information based on business scenarios > version=0.0.1\ > bizType=customer.app.KycWebApiService.findAllCusKycListByBiz\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/KYC"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.KycWebApiService.findAllCusKycListByBiz":{"post":{"summary":"Get customer's authenticated information based on business scenarios","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.KycWebApiService.findAllCusKycListByBiz\nAccess after login","operationId":"findAllCusKycListByBiz","tags":["Customer/KYC"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"businessCode":{"type":"string","description":"Business scenario code, account opening=open_account, deposit=cashin, withdrawal=withdraw, credit card=apply_credit_card"}},"required":["businessCode"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListKycAuthVO"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResultListKycAuthVO":{"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":"array","description":"Data Body","items":{"$ref":"#/components/schemas/KycAuthVO"}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"KycAuthVO":{"type":"object","properties":{"levelCode":{"type":"string","description":"Level Code"},"openAccountType":{"type":"integer","format":"int32","description":"Account type: 0. Individual 1. Enterprise "},"levelName":{"type":"string","description":"Level Name"},"pathName":{"type":"string","description":"KYC Path Name"},"pathCode":{"type":"string","description":"KYC Path Code"},"elementList":{"type":"array","description":"KYC Information List","items":{"$ref":"#/components/schemas/KycAuthElementVO"}}}},"KycAuthElementVO":{"type":"object","properties":{"elementCode":{"type":"string","description":"KYC element code"},"elementName":{"type":"string","description":"KYC element name"},"showType":{"type":"string","description":"KYC element display type"},"extend":{"type":"string","description":"KYC element extended attribute"},"elementValue":{"type":"string","description":"KYC element value"},"elementValueInputGroup":{"type":"string","description":"KYC element value, combination"},"elementCodeInputGroup":{"type":"string","description":"KYC element code, combination"}}}}}} ``` ## Does KYC Level Require KYC Authentication > version=0.0.1\ > bizType=customer.app.KycWebApiService.findAllLevelKyc\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/KYC"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.KycWebApiService.findAllLevelKyc":{"post":{"summary":"Does KYC Level Require KYC Authentication","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.KycWebApiService.findAllLevelKyc\nAccessible after login","operationId":"findAllLevelKyc","tags":["Customer/KYC"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"lang":{"type":"string","description":"Language Information"},"levelCode":{"type":"string","description":"KYC Level(\tlevel_1,level_2,\tlevel_3)"},"customerNo":{"type":"string","description":"Customer Account Number (unique within each company, not unique across companies)"},"openAccountType":{"type":"integer","format":"int32","description":"Account type: 0. Individual 1. Enterprise "},"selectCountry":{"type":"string","description":"Selected Country"},"selectCompanyType":{"type":"string","description":"Selected enterprise type"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResultListKycAuthVO"}}},"headers":{}}}}}},"components":{"schemas":{"BaseResultListKycAuthVO":{"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":"array","description":"Data Body","items":{"$ref":"#/components/schemas/KycAuthVO"}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}},"KycAuthVO":{"type":"object","properties":{"levelCode":{"type":"string","description":"Level Code"},"openAccountType":{"type":"integer","format":"int32","description":"Account type: 0. Individual 1. Enterprise "},"levelName":{"type":"string","description":"Level Name"},"pathName":{"type":"string","description":"KYC Path Name"},"pathCode":{"type":"string","description":"KYC Path Code"},"elementList":{"type":"array","description":"KYC Information List","items":{"$ref":"#/components/schemas/KycAuthElementVO"}}}},"KycAuthElementVO":{"type":"object","properties":{"elementCode":{"type":"string","description":"KYC element code"},"elementName":{"type":"string","description":"KYC element name"},"showType":{"type":"string","description":"KYC element display type"},"extend":{"type":"string","description":"KYC element extended attribute"},"elementValue":{"type":"string","description":"KYC element value"},"elementValueInputGroup":{"type":"string","description":"KYC element value, combination"},"elementCodeInputGroup":{"type":"string","description":"KYC element code, combination"}}}}}} ``` ## Get countries supporting enterprise account opening > version=0.0.1\ > bizType=customer.app.KycWebApiService.findCompanyCountry\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/KYC"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.KycWebApiService.findCompanyCountry":{"post":{"summary":"Get countries supporting enterprise account opening","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.KycWebApiService.findCompanyCountry\nAccessible after login","operationId":"findCompanyCountry","tags":["Customer/KYC"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"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":{"openCompanyCountry":{"type":"string","description":"Countries supporting enterprise account opening (corresponding country code)"}},"required":["openCompanyCountry"]},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}}} ``` ## KYC business scenario authentication application > version=0.0.1\ > bizType=customer.app.KycWebApiService.kycApply\ > Access after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/KYC"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.KycWebApiService.kycApply":{"post":{"summary":"KYC business scenario authentication application","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.KycWebApiService.kycApply\nAccess after login","operationId":"kycApply","tags":["Customer/KYC"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"levelCode":{"type":"string","description":"KYC level Code (level_1, level_2, level_3)"},"businessCode":{"type":"string","description":"Business scenario code, account opening=open_account, deposit=cashin, withdrawal=withdraw, credit card=apply_credit_card"},"openAccountType":{"type":"integer","format":"int32","description":"Account type: 0. Individual 1. Enterprise "},"elementList":{"type":"array","description":"KYC element collection","items":{"$ref":"#/components/schemas/KycWebAddInnerDTO"},"maxItems":2147483647,"minItems":1},"selectCompanyType":{"type":"string","description":"Selected enterprise type, required for enterprise authentication"},"commitTag":{"type":"boolean","description":"Whether to submit, default submission"},"selectCountry":{"type":"string","description":"Selected country, optional for enterprise authentication, empty value takes registered country"},"cardType":{"type":"string","description":"Card Type","maxLength":50}},"required":["elementList"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResult1"}}},"headers":{}}}}}},"components":{"schemas":{"KycWebAddInnerDTO":{"type":"object","required":["elementCode","elementValue"],"properties":{"elementValue":{"type":"string","description":"KYC element value"},"elementCode":{"type":"string","description":"KYC element"}}},"BaseResult1":{"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":{}},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}}} ``` ## KYC Level Certification Application > version=0.0.1\ > bizType=customer.app.KycWebApiService.kycLevelApply\ > Accessible after login ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Customer/KYC"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/customer.app.KycWebApiService.kycLevelApply":{"post":{"summary":"KYC Level Certification Application","deprecated":false,"description":"version=0.0.1\nbizType=customer.app.KycWebApiService.kycLevelApply\nAccessible after login","operationId":"kycLevelApply","tags":["Customer/KYC"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"levelCode":{"type":"string","description":"KYC level Code (level_1, level_2, level_3)"},"openAccountType":{"type":"integer","format":"int32","description":"Account type: 0. Individual 1. Enterprise "},"elementList":{"type":"array","description":"KYC element collection","items":{"$ref":"#/components/schemas/KycWebAddInnerDTO"},"maxItems":2147483647,"minItems":1},"selectCountry":{"type":"string","description":"Selected country, optional for enterprise authentication, empty value takes registered country"},"selectCompanyType":{"type":"string","description":"Selected enterprise type, required for enterprise authentication"},"commitTag":{"type":"boolean","description":"Whether to submit, default submission"}},"required":["elementList"]}}}},"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":"string","description":"Corresponding KYC pending review proposal ID"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}},"components":{"schemas":{"KycWebAddInnerDTO":{"type":"object","required":["elementCode","elementValue"],"properties":{"elementValue":{"type":"string","description":"KYC element value"},"elementCode":{"type":"string","description":"KYC element"}}}}}} ```