NHÀ PHÁT TRIỂN · CHECKID

Thực thi quy trình

Thực thi xác minh bằng multipart nội dung/bằng chứng với trường phụ thuộc loại quy trình.

HỢP ĐỒNGAPI / SDK có quản lý phiên bản
XÁC THỰCOAuth2 / môi trường
ĐẦU RAPhản hồi · mã kết quả · bằng chứng
THEO NGUỒN REST HỢP ĐỒNG

Thực thi quy trình

Thực thi the kiểm tra using a JSON nội dung plus tùy chọn bằng chứng file; trường có điều kiện depend on process_type.

Hợp đồng API nguồnCheckID API And Kafka Specifications · V1.2.260123
PUT/v1/perform/process
Bearer + OAuth2 Client Credentials · multipart/form-data3.6 · Thực thi quy trìnhnguồn p.21

Thực thi the kiểm tra using a JSON nội dung plus tùy chọn bằng chứng file; trường có điều kiện depend on process_type.

Mở trong Trình khám phá API ↗
Trường Loại Yêu cầu Mô tả
payload Đối tượng M JSON đối tượng sent as multipart text
evidence Mảng byte M/O Tệp tải lên khi loại quy trình yêu cầu
YÊU CẦU — DỮ LIỆU ĐÃ ẨN DANHKHÔNG CHỨA THÔNG TIN BÍ MẬT MÔI TRƯỜNG THỰC TẾ
{
  "payload": {
    "subject_id": "<CHỦ THỂ_ID>",
    "process_id": "<PROCESS_ID>",
    "lang": "en"
  },
  "evidence": "<BINARY_FILE_WHEN_REQUIRED>"
}
PHẢN HỒICẤU TRÚC DỮ LIỆU ĐÃ ĐẶC TẢ
{
  "status": 0,
  "message": "SUCCESSFULLY",
  "dtis_id": "<DTIS_TRANSACTION_ID>",
  "process_type": "LIVE_FACIAL_MATCHING_EKYC",
  "perform_result": {
    "final_result": {
      "match_result": true,
      "liveness": true,
      "claim_sources": {
        "JWT": "<SIGNED_JWT>"
      }
    }
  }
}
Phạm vi công bốVí dụ được thay bằng giá trị giữ chỗ rõ ràng; website không gửi yêu cầu tới môi trường môi trường thật.
NỘI DUNG CÓ ĐIỀU KIỆN

Trường phụ thuộc process_type

Không hiển thị trường có điều kiện như chung mandatory.

identity_documentM/OPA · live facial · vân tay · đối sánh khuôn mặt
evidence_upload_typeM/OKYC · LIVENESS · KIỂM CHỨNG · MATCHED; áp dụng cho một số quy trình khuôn mặt và liveness
otpM/OEMAIL_AUTHENTICATION · MOBILE_AUTHENTICATION
framesM/OCác loại quy trình xác thực khuôn mặt và thực thể sống
fingerprintM/OQuy trình so khớp vân tay
left_fingerprints / right_fingerprintsM/OFINGERPRINT_ENROLLING
pa_dataM/OPASSIVE_AUTHENTICATION
os_typeM/OPASSIVE_AUTHENTICATION
reader_snM/OPA trên WIN theo tài liệu nguồn
session_key_dataM/OPASSIVE_AUTHENTICATION
THAM CHIẾU API

Đặc tả thực tế: Thực thi quy trình

PUT · /v1/perform/process

Điểm kết nối & mục đích

PUT /v1/perform/process. Thực thi quy trình với bằng chứng có điều kiện theo từng loại quy trình.

Xác thực

Bearer . Không thay đổi cơ chế này bằng suy đoán từ tài liệu kế thừa.

Phạm vi công bố

Đối tác. Nguồn: CheckID API đặc tả V1.2.260123 §2.2.12.

Cấu trúc yêu cầu

{
  "payload": {
    "process_type": "PASSIVE_AUTHENTICATION",
    "operating_system": "WINDOWS"
  },
  "evidence": "<BINARY_EVIDENCE>"
}

Cấu trúc phản hồi

{
  "process_status": "ACCEPTED",
  "perform_result": {
    "passive_authentication_status": "PARTIAL_VALID"
  },
  "x-billcode-id": "<BILLCODE_ID>"
}

Lỗi / khôi phục

Ngữ nghĩa lỗi phải dùng raw đặc tả/danh mục lỗi; cơ chế thử lại/tính bất biến khi lặp/thời gian chờ chỉ được áp dụng nếu nguồn tương ứng định nghĩa.