EKYC

Truy vấn thông tin định danh cá nhân và doanh nghiệp đã xác thực qua bankHub ID

API Reference

View eKYC requests, responses and example code

View eKYC API

Quickstart

Learn about the information to deploy and how it works.

Get started

Với ứng dụng bankHub ID, bankHub có thể định danh khách hàng cũng như doanh nghiệp thuộc quyền sở hữu bởi khách hàng. Từ đó, bankHub cung cấp API này cho phép khách hàng cấp quyền truy cập thông tin của KH cho ứng dụng của bạn với những thông tin đã được xác thực.

Các bước tích hợp eKYC

Dưới đây là các bước để tích hợp eKYC vào sản phẩm của bạn.

1. Tạo một phân quyền /grant/token với scopes có giá trị là ekyc.

2. Mở giao diện bankHub Link bằng grantToken được trả về ở bước trên. Xem chi tiết

3. Khách hàng của bạn mở ứng dụng bankHub ID và quét mã QR trên bankHub Link.

4. Sau khi người dùng hoàn tất chấp nhận quyền truy cập thông tin của họ cho Ứng dụng của bạn, phía giao diện của bạn sẽ nhận được một publicToken, dùng publicToken này để lấy accessToken cho phân quyền. AccessToken này chỉ có thể truy cập trong vòng 5 phút. Sau 5 phút ứng dụng của bạn muốn truy cập lại thông tin thì bắt buộc làm lại từ bước 1.

5. Bây giờ bạn đã có thể gọi API truy vấn thông tin định danh.

Gọi API

Tạo phân quyền cho eKYC

CURL

curl --location 'https://sandbox.bankhub.dev/grant/token' \
--header 'X-BankHub-Api-Version: 2023-01-01' \
--header 'x-client-id: <CLIENT_ID_HERE>' \
--header 'x-secret-key: <SECRET_KEY_HERE>' \
--header 'Content-Type: application/json' \
--data '{
    "scopes": "ekyc",
    "language": "vi",
    "redirectUri": "https://your-domain.vn/link",
}'

Javascript (Axios)

 const axios = require('axios');
 const data = JSON.stringify({
   "scopes": "ekyc",
   "language": "vi",
   "redirectUri": "https://your-domain.vn/link",
 });

 const config = {
   method: 'post',
   maxBodyLength: Infinity,
   url: 'https://sandbox.bankhub.dev/grant/token',
   headers: { 
     'X-BankHub-Api-Version': '2023-01-01', 
     'x-client-id': '<CLIENT_ID_HERE>', 
     'x-secret-key': '<SECRET_KEY_HERE>', 
     'Content-Type': 'application/json',
   },
   data: data
 };

 axios.request(config)
 .then((response) => {
   console.log(JSON.stringify(response.data));
 })
 .catch((error) => {
   console.log(error);
 });

info

Xem chi tiết API, tại đây

Lấy accessToken từ publicToken

CURL

  curl --location 'https://sandbox.bankhub.dev/grant/exchange' \
  --header 'X-BankHub-Api-Version: 2023-01-01' \
  --header 'x-client-id: <CLIENT_ID_HERE>' \
  --header 'x-secret-key: <SECRET_KEY_HERE>' \
  --header 'Content-Type: application/json' \
  --data '{
      "publicToken": "bdbde2bad-7685-4f95-987c-71309a4a3"
  }'

Javascript (Axios)

  const axios = require('axios');
  const data = JSON.stringify({
    "publicToken": "bdbde2bad-7685-4f95-987c-71309a4a3"
  });

  const config = {
    method: 'post',
    maxBodyLength: Infinity,
    url: 'https://sandbox.bankhub.dev/grant/exchange',
    headers: { 
      'X-BankHub-Api-Version': '2023-01-01', 
      'x-client-id': '<CLIENT_ID_HERE>', 
      'x-secret-key': '<SECRET_KEY_HERE>', 
      'Content-Type': 'application/json'
    },
    data: data
  };

  axios.request(config)
    .then((response) => {
      console.log(JSON.stringify(response.data));
    })
    .catch((error) => {
      console.log(error);
    });

info

Xem chi tiết API, tại đây

API truy vấn thông tin định danh Cá nhân hoặc Doanh nghiệp đã xác thực

CURL

  curl --location 'https://sandbox.bankhub.dev/ekyc' \
  --header 'X-BankHub-Api-Version: 2023-01-01' \
  --header 'Authorization: <ACCESS_TOKEN_HERE>' \
  --header 'x-client-id: <CLIENT_ID_HERE>' \
  --header 'x-secret-key: <SECRET_KEY_HERE>'

Javascript (Axios)

  const axios = require('axios');

  const config = {
    method: 'get',
    maxBodyLength: Infinity,
    url: 'https://sandbox.bankhub.dev/ekyc',
    headers: { 
      'X-BankHub-Api-Version': '2023-01-01', 
      'Authorization': '<ACCESS_TOKEN_HERE>', 
      'x-client-id': '<CLIENT_ID_HERE>', 
      'x-secret-key': '<SECRET_KEY_HERE>',
    },
  };

  axios.request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

info

Xem chi tiết API, tại đây