Skip to content

Tạo giao dịch ​

Mở một giao dịch eKYC cho một người dùng và trả về JWT token mà Mobile SDK dùng để xác thực. Đây là lệnh gọi đầu tiên trong một phiên eKYC do SDK điều khiển.

Endpoint ​

http
POST /v1/create_ekyc_transaction
Content-Type: application/json
json
{
  "user_id": "user_00000001",
  "ref_id": "ref_00000001",
  "level": 0
}

Tham số:

Tham sốKiểuBắt buộcMặc địnhMô tả
user_idstringCó—User ID.
ref_idstringCó—ID tham chiếu giao dịch do bạn tạo và quản lý.
levelintKhông0Cấp độ challenge. Cấp độ càng cao yêu cầu kiểm tra càng nghiêm ngặt.

Header:

HeaderBắt buộcMô tả
App-IdKhôngApp-Id mà giao dịch được giới hạn phạm vi theo đó. Mặc định là default nếu bỏ qua.

Trả về: CreateTransactionResponse

Ví dụ request ​

bash
curl --location '<BASE_URL>/v1/create_ekyc_transaction' \
  --header 'Authorization: ATV <ACCESS_ID>:<SIGNATURE>' \
  --header 'X-TV-Timestamp: <TIMESTAMP>' \
  --header 'App-Id: <APP_ID>' \
  --header 'Content-Type: application/json' \
  --data '{
    "user_id": "user_00000001",
    "ref_id": "ref_00000001",
    "level": 0
  }'

Response ​

json
{
  "success": true,
  "code": 0,
  "message": "Success",
  "request_id": "f48085e4-3ae4-40bb-b0e1-9b2c72575bc1",
  "data": {
    "id": "85712834-558f-4d9b-81bd-a2ab3b9a3aad",
    "ref_id": "ref_00000001",
    "user_id": "user_00000001",
    "status": "NOT_VERIFIED",
    "token": "<JWT_TOKEN>"
  }
}
TrườngKiểuMô tả
data.idstringID duy nhất của giao dịch.
data.ref_idstringID tham chiếu giao dịch bạn đã cung cấp.
data.user_idstringUser ID.
data.statusstringNOT_VERIFIED, VERIFIED hoặc EXPIRED.
data.tokenstringJWT token mà Mobile SDK dùng để xác thực với server.
errorsarrayChi tiết từng lỗi. Rỗng khi thành công.
successboolCuộc gọi có thành công hay không.
codeintstatus code dạng số — 0 khi thành công.

INFO

Response trả về user_id, khớp với request. Hãy liên hệ đội CAKE nếu bạn thấy document_id ở vị trí đó.

WARNING

token chỉ có hiệu lực trong phạm vi một giao dịch và sẽ hết hạn. Hãy chuyển nó cho SDK qua kênh xác thực riêng của bạn và không bao giờ ghi log — Access Key phải luôn ở lại phía backend của bạn.

Lỗi ​

MãThông báo
2001010Không tìm thấy Access ID.
2001020Lock giao dịch thất bại.
2001021Request giao dịch không hợp lệ.
2002206Hồ sơ người dùng đã bị khóa.
401100Bạn không được phép thực hiện hành động này.
4001000Tham số đầu vào vi phạm một ràng buộc.
4001001Header X-TV-Timestamp đã hết hạn, cần một cái mới hơn.
5001000Xảy ra lỗi không mong đợi trong quá trình xử lý request.
MãMô tả
access_id_not_foundAPI key không đúng.
transaction_lock_failedLock giao dịch thất bại.
transaction_invalid_requestRequest giao dịch không hợp lệ.
access_denied_exceptionBạn không được phép thực hiện hành động này.
user_profile_not_found_exceptionKhông tìm thấy hồ sơ của người dùng.
user_profile_lockedHồ sơ người dùng đã bị khóa.
internal_server_errorXảy ra lỗi không mong đợi trong quá trình xử lý request.

Bước tiếp theo ​

Developers