API Reference

申请卡流程

使用前,請詳細閱讀《KYC須知》

接口調用流程

KYC條件根據用戶註冊時選擇的國家獲取,不同國家的KYC條件可能不同。(目前所有國家的KYC條件都一樣)

打開頁面時,可以先檢查用戶是否已經提交KYC信息,如果已經提交,可以提示用戶不用重複填寫KYC信息。

調用获取KYC认证條件(/customer.app.KycWebApiService.findAllBizKyc)的接口獲取KYC條件;

elementList列表是需要用戶填寫的KYC信息,根据elementList配置动态生成一个form表单,表单项的字段名称就是elementCode值,表單項的輸入類型參考下面的showType类型介绍:

{
    "showType": "input",  // KYC元素显示类型,詳情查看下方的`showType`类型介绍
    "elementCode": "first_name",  // KYC元素code,提交時用elementCode作為key,用戶輸入的內容作為value形成健值對,例如:{"first_name": "David", "last_name": "Smith" }
   //  .... 其他字段
}

showType类型介绍

类型介绍
input輸入框
select下拉框 (使用elementCode请求下方的字典接口獲取下拉框選項)
date日期,提交的時候傳對應的時間戳給接口
inputGroup组合輸入框
image上傳圖片

當前配置的KYC條件的elementCode字段介紹:

必填字段介绍
first_name英文名,僅支持英文字母/拼音
last_name英文姓,僅支持英文字母/拼音
zh_first_name中文名,僅支持中文
zh_last_name中文姓, 僅支持中文
occupation職業,根据parentCode: "occupation" 获取数据字典;可以不展示在頁面上,直接從選項裡面隨機取一個值提交
annualIncome收入,根据parentCode: "annualIncome" 获取数据字典;可以不展示在頁面上,直接從選項裡面隨機取一個值提交
position職位,根据parentCode: "position" 获取数据字典;可以不展示在頁面上,直接從選項裡面隨機取一個值提交
birthday出生日期,傳時間戳给接口
country国家地区,使用 获取国家列表 返回的 code 字段
id_card_type证件类型,下拉选项列表从字典里面获取
front_identity_card身份證正面; 證件類型為身份證,則必填;取值為上傳圖片接口返回的圖片地址
back_identity_card身份證反面,證件類型為身份證,則必填;取值為上傳圖片接口返回的圖片地址
proof_of_passpord护照证明,證件類型為护照,則必填;取值為上傳圖片接口返回的圖片地址
proof_of_drive駕照證明,證件類型為駕照,則必填;取值為上傳圖片接口返回的圖片地址
expiry_date_unlimited证件是否有有效期,下拉選項根据parentCode: "expiry_date_unlimited" 获取数据字典
expiry_date证件有效期
sex性別,下拉選項根据parentCode: "sex" 获取数据字典

以上KYC元素,若showType值为select,從下方的字典介面裡面獲取選項清單

相關接口

檢查申請信用卡KYC是否通過/customer.app.KycWebApiService.checkKycApply

// 檢查申請信用卡KYC是否通過的接口參數示例:
{
    "businessCode": "apply_credit_card"
}

获取KYC认证條件/customer.app.KycWebApiService.findAllBizKyc

// 获取KYC认证條件的接口參數示例:
{
    "businessCode": "apply_credit_card"
}

獲取國家列表::/config.app.AppDictDubboService.getCountryListByParentCode

// 獲取國家列表的接口參數示例:
{
    "parentCode": "-1",    // 這裡固定傳-1
    "unitId": "32"
}

字典基于code查询/config.app.AppDictDubboService.getListByParentCode

// 获取KYC认证條件的接口參數示例:
{
    "parentCode": "sex"  // sex 性別, occupation 職業, annualIncome 收入, position 職位, id_card_type 证件类型, expiry_date_unlimited 证件是否有有效期
}

图片上传/passToCreditUpload

// 图片上传的接口參數示例(使用form表單文件流形式上傳):
------WebKitFormBoundaryFL8ymxbYNf8DmchX
Content-Disposition: form-data; name="object"; filename="1111.png"
Content-Type: image/png

------WebKitFormBoundaryFL8ymxbYNf8DmchX--

申请信用卡提交KYC认证/customer.app.KycWebApiService.kycApply

// 申请信用卡提交KYC认证的接口參數示例:
{
    "businessCode": "apply_credit_card",
    "levelCode": "level_1",
    "elementList": [
        {
            "elementCode": "occupation",
            "elementValue": "occupation_8"
        },
        {
            "elementCode": "annualIncome",
            "elementValue": "annualIncom_1"
        },
        {
            "elementCode": "position",
            "elementValue": "position_2"
        },
        {
            "elementCode": "expiry_date_unlimited",
            "elementValue": "1"
        },
        {
            "elementCode": "first_name",
            "elementValue": "AMIR"
        },
        {
            "elementCode": "last_name",
            "elementValue": "LIU"
        },
        {
            "elementCode": "zh_first_name",
            "elementValue": "名字"
        },
        {
            "elementCode": "zh_last_name",
            "elementValue": "姓氏"
        },
        {
            "elementCode": "birthday",
            "elementValue": 1704124800000
        },
        {
            "elementCode": "expiry_date",
            "elementValue": 1706630400000
        },
        {
            "elementCode": "id_card_type",
            "elementValue": "identity_card"
        },
        {
            "elementCode": "identity_card",
            "elementValue": "8888888888"
        },
        {
            "elementCode": "sex",
            "elementValue": "man"
        },
        {
            "elementCode": "country",
            "elementValue": "HK"
        },
        {
            "elementCode": "front_identity_card",
            "elementValue": "https://cats2.s3.ap-east-1.amazonaws.com/cats/93792bca-1c58-43da-a238-8a5c471552ae.png"
        },
        {
            "elementCode": "back_identity_card",
            "elementValue": "https://cats2.s3.ap-east-1.amazonaws.com/cats/581e2578-7fb5-4fec-b460-9c73bb4040fb.png"
        },
    ],
    "cardType": 1,
    "unitId": "32"
}

申請信用卡/passToCredit.app.AppCardActiveService.applyCard

// 申請信用卡的接口參數示例:
{
    "type": 1,
    "firstName": "AMIR",
    "lastName": "LIU",
    "applyEntity": true,
    "kycPno": "K804118815758614528",
    "applyCurrency": "HKD",
    "mailingAddress": "详细地址",
    "mailingCity": "城市",
    "mailingCountry": "HK",
    "mailingProvince": "州省",
    "postalCode": "518000",
    "address": "中國香港 州省 城市 详细地址",
    "unitId": "32"
}

查询客户语言/customer.app.CustomerWebApiService.findCustomerLang

// 查询客户语言的接口參數示例:
{
    // 無參數
}

切換客戶語言/customer.app.CustomerWebApiService.changeLang

// 這裡切換語言主要是處理公告消息、短信的語言,比如說激活卡,刷卡時收到短信,是根據這裡的語言來推送短信模板
// 切換客戶語言的接口參數示例:
{
    "newLang": "zh-HK", // zh-HK 中文繁體, zh-CN中文簡體, en-US英文
    "unitId": "32"
}

常見問題

  • 一人可以申請幾張信用卡?
    回答:同一種卡在同一白標機構,一人只能申請一張卡。
  • 現在支持多少種語言?
    回答:3種,zh-HK 中文繁體, zh-CN中文簡體, en-US英文。