Cấu hình lấy dữ liệu và kết quả eKYC

Tài liệu này hướng dẫn khách hàng cách cấu hình để lấy dữ liệu và kết quả eKYC từ hệ thống FPT AI eKYC về máy chủ của khách hàng. Để truy cập trang cấu hình, bạn cần đăng nhập vào hệ thống eKYC Portal, chọn ngôn ngữ VI và chọn tab Cấu hình eKYC ở menu bên trái. Sau đó, chọn Lấy dữ liệu trong menu phụ.

Hệ thống FPT AI eKYC hỗ trợ 2 phương thức trả dữ liệu và kết quả "server-to-server" cho khách hàng:

• Callback: Hệ thống sẽ chủ động gửi dữ liệu về API của khách hàng đã cấu hình trước đó trên eKYC Portal.
• Dùng API để lấy dữ liệu: Hệ thống sẽ cung cấp cho khách hàng một API để khách hàng chủ động gọi và lấy dữ liệu về.

ghi chú

Đối với khách hàng sử dụng proxy server ở giữa SDK và eKYC server thì không cần thiết sử dụng các phương thức này. Các dữ liệu và kết quả của luồng eKYC có thể được lưu lại ngay từ proxy server. Chi tiết về phương án tích hợp sử dụng proxy server, vui lòng tham khảo tài liệu Tích hợp sử dụng Proxy Server

1. Bật tắt các phương thức lấy dữ liệu

• Cách cấu hình: Sử dụng nút gạt để bật hoặc tắt tất cả các phương thức lấy dữ liệu.

2. Cấu hình lấy dữ liệu qua Callback

Hệ thống FPT AI eKYC hỗ trợ 2 phương án xác thực khi gửi dữ liệu về API của khách hàng:

• Fixed Token
• Dynamic Token

2.1. Cấu hình lấy dữ liệu qua Callback với phương thức Fixed Token

2.1.1. Mô tả cấu hình

• Token Type: Chọn phương thức xác thực là Fixed Token.
• Callback Data Key: tên khóa chứa dữ liệu mà hệ thống gửi về, dữ liệu sẽ được chứa trong kiểu Object.
• Request Payloads: thông tin bổ sung mà khách hàng muốn hệ thống gửi về thêm.
• Retry Interval: khoảng thời gian (đơn vị Giây) hệ thống sẽ gửi lại dữ liệu nếu không nhận được phản hồi thành công từ API của khách hàng. Khoảng thời gian thử lại mặc định là 30 giây.
• Retry Count: số lần hệ thống sẽ gửi lại dữ liệu nếu không nhận được phản hồi từ API của khách hàng. Mặc định hệ thống sẽ gửi lại 5 lần.
• Timeout: thời gian tối đa mà hệ thống sẽ chờ phản hồi từ API của khách hàng (đơn vị Giây). Nếu quá thời gian này mà không nhận được phản hồi thành công thì hệ thống sẽ gửi lại dữ liệu theo "Retry Interval" đã cấu hình ở trên. Thời gian timeout mặc định là 60 giây.
• Callback Url: địa chỉ API mà hệ thống sẽ gửi dữ liệu về.
• Request Headers: thông tin headers của request mà khách hàng muốn hệ thống gửi về thêm.

2.1.2. Ví dụ cấu hình

Giả sử khách hàng đã dựng API xác thực bằng API key để nhận dữ liệu từ hệ thống eKYC với các thông tin như sau:

• URL: https://example.com/ekyc/callback
• Cách gửi dữ liệu:

curl -X POST https://example.com/ekyc/callback \
--header "api-key: 123456789" \
--data-raw "customize_data_key: ekyc_data"

(Dữ liệu mẫu ekyc_data có thể tham khảo ở tài liệu Mẫu dữ liệu callback)

tương ứng với các thông tin cấu hình như sau:

2.2. Cấu hình lấy dữ liệu qua Callback với phương thức Dynamic Token

2.2.1. Mô tả cấu hình

• Token Type: Chọn phương thức xác thực là Dynamic Token.
• GET_TOKEN_INFO: phần này bao gồm các cấu hình để hệ thống eKYC có thể tự động lấy và quản lý token sinh từ hệ thống của khách hàng. Các cấu hình cho API lấy token bao gồm:
  • url: địa chỉ API mà hệ thống sẽ gọi để lấy token.
  • valid_time_predefined: (không bắt buộc) thời gian mà token này có hiệu lực (đơn vị Giây), định nghĩa trước cho hệ thống eKYC. Nếu không cấu hình thì hệ thống sẽ tự động lấy thời gian hiệu lực của token từ API trả về.
  • response_info: phần này bao gồm các cấu hình về vị trí của thông tin cần lấy trong response của API lấy token. Các thông tin cần lấy gồm có token và expired_time.
    • token
      • index: vị trí của token trong giá trị của khóa chứa token.
      • key: tên khóa chứa token mà hệ thống sẽ lấy từ response của API.
    • expired_time
      • index: vị trí của thời gian hết hạn trong giá trị của khóa chứa thời gian hết hạn.
      • key: tên khóa chứa thời gian hết hạn mà hệ thống sẽ lấy từ response của API.
  • payloads: thông tin bổ sung mà khách hàng muốn hệ thống gửi về thêm.
  • headers: thông tin headers của request mà khách hàng muốn hệ thống gửi về thêm.

Ví dụ với response của API lấy token như sau:

{
    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6Ikp...",
    "token_type": "Bearer",
    "expires_in": 3600
}

thì khách hàng để trống các trường index trong response_info, và cấu hình các trường key như sau:

• TOKEN_SCHEME: nhập giá trị Bearer. Chuỗi này sẽ được thêm vào trước token mà hệ thống lấy được từ API lấy token. Nếu không cấu hình thì hệ thống sẽ không thêm gì vào trước token.

Các cấu hình còn lại tương tự như phương thức Fixed Token ở trên.

2.2.2. Ví dụ cấu hình

Ngoài cấu hình lấy token như mô tả ở trên 2.2.1, khách hàng tham khảo ví dụ cấu hình như của phương thức Fixed Token.

3. Cấu hình lấy dữ liệu qua API

• Mô tả: Ngoài việc bên phía khách hàng dựng API để nhận dữ liệu callback từ hệ thống FPT AI eKYC khi phiên eKYC kết thúc, khách hàng cũng có thể chủ động gọi API của hệ thống để lấy dữ liệu về.
• Cách cấu hình: Sử dụng nút gạt để bật hoặc tắt phương thức lấy dữ liệu qua API "ENABLE API GET RESULT" (Chú ý để thấy được tùy chọn này, tùy chọn "ENABLE RETRIEVING DATA" cần phải được bật trước).
• Tài liệu API lấy dữ liệu: Xem chi tiết về API lấy dữ liệu tại tài liệu
• Lưu ý:
  • Mặc định hệ thống FPT AI eKYC sẽ không lưu lại các thông tin cá nhân của người dùng cuối sau khi phiên eKYC kết thúc. Do đó, để đảm bảo lấy được dữ liệu, khách hàng cần phải cấu hình "Thời gian lưu dữ liệu" ít nhất từ 1 ngày trở lên (xem tài liệu)
  • Khách hàng chỉ lấy được dữ liệu qua API trong khoảng thời gian lưu dữ liệu đã cấu hình. Sau khoảng thời gian này, hệ thống sẽ không lưu lại dữ liệu của người dùng cuối nữa.

ghi chú

• Đảm bảo nhấn nút Cập nhật thông tin sau khi thực hiện các thay đổi để áp dụng cấu hình mới.
• Nếu có bất kỳ vấn đề nào, vui lòng liên hệ với bộ phận hỗ trợ kỹ thuật.