Customer/KYC

Is the business scenario KYC approved?

post

version=0.0.1 bizType=customer.app.KycWebApiService.checkKycApply Can access after login

Header parameters

companyIdstringOptionalExample: {{company}}

tokenstringOptionalExample: {{LoginResult.data.token}}

langstringOptionalExample: en-US

tracestringOptionalExample: {{mock_trace}}

versionstringOptionalExample: 0.0.1

Body

openAccountTypeinteger · int32Optional

Account type: 0. Individual 1. Enterprise

businessCodestringRequired

Business scenario code, account opening=open_account, deposit=cashin, withdrawal=withdraw, credit card=apply_credit_card

Responses

200Success

application/json

post

/global/customer.app.KycWebApiService.checkKycApply

POST /api/global/customer.app.KycWebApiService.checkKycApply HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "openAccountType": 1,
  "businessCode": "text"
}

200Success

{
     "msg": "Success",
     "fail": false,
     "trace": "x-y87e-cait-r4b6-c135wj-1677641720",
     "code": "0",
     "data": 2,//Normal 2=success, abnormal status [0 authentication, 1 under review, 3 review rejection]
     "bizCode": "",
     "tm": 6551651,
     "msgParams": "CUSTOMER_API_0000602",
     "ok": true
 }

Get KYC authentication information for business scenarios

post

version=0.0.1 bizType=customer.app.KycWebApiService.findAllBizKyc Accessible after login

Header parameters

companyIdstringOptionalExample: {{company}}

tokenstringOptionalExample: {{LoginResult.data.token}}

langstringOptionalExample: en-US

tracestringOptionalExample: {{mock_trace}}

versionstringOptionalExample: 0.0.1

Body

businessCodestringRequired

Business scenario code, account opening=open_account, deposit=cashin, withdrawal=withdraw, credit card=apply_credit_card

openAccountTypeinteger · int32Optional

Account type: 0. Individual 1. Enterprise

Responses

200Success

application/json

post

/global/customer.app.KycWebApiService.findAllBizKyc

POST /api/global/customer.app.KycWebApiService.findAllBizKyc HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "businessCode": "text",
  "openAccountType": 1
}

200Success

{
  "msg": "Success",
  "fail": false,
  "trace": "x-4djg1xe-p9sygx2-1v7k21-y2z1g-1677642057",
  "code": "0",
  "data": [],
  "bizCode": "",
  "tm": 4315987,
  "msgParams": null,
  "ok": true
}

Identity authentication list

post

version=0.0.1 bizType=customer.app.KycWebApiService.findAllBizKycList Accessible after login

Header parameters

companyIdstringOptionalExample: {{company}}

tokenstringOptionalExample: {{LoginResult.data.token}}

langstringOptionalExample: en-US

tracestringOptionalExample: {{mock_trace}}

versionstringOptionalExample: 0.0.1

Body

openAccountTypeinteger · int32Optional

Account type: 0. Individual 1. Enterprise

Responses

200Success

application/json

post

/global/customer.app.KycWebApiService.findAllBizKycList

POST /api/global/customer.app.KycWebApiService.findAllBizKycList HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "openAccountType": 1
}

200Success

{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "data": [
    {
      "levelCode": "text",
      "levelName": "text",
      "status": 1,
      "statusName": "text",
      "sort": 1,
      "preLevelName": "text",
      "businessNameList": [
        "text"
      ],
      "businessCodeList": [
        "text"
      ],
      "companyType": "text",
      "openAccountType": "text",
      "pathCode": "text"
    }
  ],
  "ok": true,
  "fail": true
}

Get customer's authenticated information based on business scenarios

post

version=0.0.1 bizType=customer.app.KycWebApiService.findAllCusKycListByBiz Access after login

Header parameters

companyIdstringOptionalExample: {{company}}

tokenstringOptionalExample: {{LoginResult.data.token}}

langstringOptionalExample: en-US

tracestringOptionalExample: {{mock_trace}}

versionstringOptionalExample: 0.0.1

Body

businessCodestringRequired

Business scenario code, account opening=open_account, deposit=cashin, withdrawal=withdraw, credit card=apply_credit_card

Responses

200Success

application/json

post

/global/customer.app.KycWebApiService.findAllCusKycListByBiz

POST /api/global/customer.app.KycWebApiService.findAllCusKycListByBiz HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "businessCode": "text"
}

200Success

{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "data": [
    {
      "levelCode": "text",
      "openAccountType": 1,
      "levelName": "text",
      "pathName": "text",
      "pathCode": "text",
      "elementList": [
        {
          "elementCode": "text",
          "elementName": "text",
          "showType": "text",
          "extend": "text",
          "elementValue": "text",
          "elementValueInputGroup": "text",
          "elementCodeInputGroup": "text"
        }
      ]
    }
  ],
  "ok": true,
  "fail": true
}

Does KYC Level Require KYC Authentication

post

version=0.0.1 bizType=customer.app.KycWebApiService.findAllLevelKyc Accessible after login

Header parameters

companyIdstringOptionalExample: {{company}}

tokenstringOptionalExample: {{LoginResult.data.token}}

langstringOptionalExample: en-US

tracestringOptionalExample: {{mock_trace}}

versionstringOptionalExample: 0.0.1

Body

langstringOptional

Language Information

levelCodestringOptional

KYC Level( level_1,level_2, level_3)

customerNostringOptional

Customer Account Number (unique within each company, not unique across companies)

openAccountTypeinteger · int32Optional

Account type: 0. Individual 1. Enterprise

selectCountrystringOptional

Selected Country

selectCompanyTypestringOptional

Selected enterprise type

Responses

200Success

application/json

post

/global/customer.app.KycWebApiService.findAllLevelKyc

POST /api/global/customer.app.KycWebApiService.findAllLevelKyc HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "levelCode": "level_1"
}

200Success

{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "data": [
    {
      "levelCode": "text",
      "openAccountType": 1,
      "levelName": "text",
      "pathName": "text",
      "pathCode": "text",
      "elementList": [
        {
          "elementCode": "text",
          "elementName": "text",
          "showType": "text",
          "extend": "text",
          "elementValue": "text",
          "elementValueInputGroup": "text",
          "elementCodeInputGroup": "text"
        }
      ]
    }
  ],
  "ok": true,
  "fail": true
}

Get countries supporting enterprise account opening

post

version=0.0.1 bizType=customer.app.KycWebApiService.findCompanyCountry Accessible after login

Header parameters

companyIdstringOptionalExample: {{company}}

tokenstringOptionalExample: {{LoginResult.data.token}}

langstringOptionalExample: en-US

tracestringOptionalExample: {{mock_trace}}

versionstringOptionalExample: 0.0.1

Body

objectOptional

Responses

200Success

application/json

post

/global/customer.app.KycWebApiService.findCompanyCountry

POST /api/global/customer.app.KycWebApiService.findCompanyCountry HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200Success

{
  "msg": "Success",
  "fail": false,
  "trace": "x-0m1j4g7-9f99i12r-n8f86-ev41-1677649081",
  "code": "0",
  "data": {
    "companyId": 360,
    "createTime": 1647485223229,
    "action": "manual",
    "updateTime": 1675775113871,
    "id": 1504288172189061000,
    "openCompanyCountry": "MC,CN"
  },
  "bizCode": "",
  "tm": 3817612,
  "msgParams": null,
  "ok": true
}

KYC business scenario authentication application

post

version=0.0.1 bizType=customer.app.KycWebApiService.kycApply Access after login

Header parameters

companyIdstringOptionalExample: {{company}}

tokenstringOptionalExample: {{LoginResult.data.token}}

langstringOptionalExample: en-US

tracestringOptionalExample: {{mock_trace}}

versionstringOptionalExample: 0.0.1

Body

levelCodestringOptional

KYC level Code (level_1, level_2, level_3)

businessCodestringOptional

Business scenario code, account opening=open_account, deposit=cashin, withdrawal=withdraw, credit card=apply_credit_card

openAccountTypeinteger · int32Optional

Account type: 0. Individual 1. Enterprise

selectCompanyTypestringOptional

Selected enterprise type, required for enterprise authentication

commitTagbooleanOptional

Whether to submit, default submission

selectCountrystringOptional

Selected country, optional for enterprise authentication, empty value takes registered country

cardTypestring · max: 50Optional

Card Type

Responses

200Success

application/json

post

/global/customer.app.KycWebApiService.kycApply

POST /api/global/customer.app.KycWebApiService.kycApply HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 208

{
  "levelCode": "text",
  "businessCode": "text",
  "openAccountType": 1,
  "elementList": [
    {
      "elementValue": "text",
      "elementCode": "text"
    }
  ],
  "selectCompanyType": "text",
  "commitTag": true,
  "selectCountry": "text",
  "cardType": "text"
}

200Success

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

KYC Level Certification Application

post

version=0.0.1 bizType=customer.app.KycWebApiService.kycLevelApply Accessible after login

Header parameters

companyIdstringOptionalExample: {{company}}

tokenstringOptionalExample: {{LoginResult.data.token}}

langstringOptionalExample: en-US

tracestringOptionalExample: {{mock_trace}}

versionstringOptionalExample: 0.0.1

Body

levelCodestringOptional

KYC level Code (level_1, level_2, level_3)

openAccountTypeinteger · int32Optional

Account type: 0. Individual 1. Enterprise

selectCountrystringOptional

Selected country, optional for enterprise authentication, empty value takes registered country

selectCompanyTypestringOptional

Selected enterprise type, required for enterprise authentication

commitTagbooleanOptional

Whether to submit, default submission

Responses

200Success

application/json

post

/global/customer.app.KycWebApiService.kycLevelApply

POST /api/global/customer.app.KycWebApiService.kycLevelApply HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "levelCode": "level_1",
  "elementList": [
    {
      "elementCode": "applyCurrency",
      "elementValue": "HKD"
    },
    {
      "elementCode": "type",
      "elementValue": "1"
    }
  ]
}

200Success

{     "msg": "Success",     "fail": false,     "trace": "x-eb9so-p7qxs-7588-88mm-1677650372",     "code": "0",     "data": "K683312403240189952",//Corresponding KYC pending review proposal ID     "bizCode": "",     "tm": 28692396,     "msgParams": null,     "ok": true }

PreviousCustomer/Verification NextCustomer/Open API

Last updated 1 month ago