NHÀ PHÁT TRIỂN · CHECKID

Tạo chủ thể

Tạo chủ thể trước khi khởi tạo kiểm tra danh tí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

Tạo chủ thể

Tạo tài nguyên chủ thể đại diện cho chủ thể sẽ được kiểm tra.

Hợp đồng API nguồnCheckID API And Kafka Specifications · V1.2.260123
POST/v1/create/subject
Bearer + OAuth2 Client Credentials3.3 · Creates chủ thểnguồn p.12

Tạo tài nguyên chủ thể đại diện cho chủ thể sẽ được kiểm tra.

Mở trong Trình khám phá API ↗
Trường Loại Yêu cầu Mô tả
lang String O Ngôn ngữ phản hồi
mobile String O Số điện thoại di động
email String O Email
identity_document Đối tượng O Chủ thể giấy tờ danh tính
external_id String O Mã theo dõi của bên tin cậy
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Ế
{
  "email": "demo.user@example.invalid",
  "mobile": "+84000000000",
  "external_id": "demo-subject-001",
  "identity_document": {
    "type": "CITIZEN_CARD",
    "value": "<CITIZEN_ID_SAMPLE>"
  },
  "lang": "en"
}
PHẢN HỒICẤU TRÚC DỮ LIỆU ĐÃ ĐẶC TẢ
{
  "status": 0,
  "message": "SUCCESSFULLY",
  "dtis_id": "<DTIS_TRANSACTION_ID>",
  "subject_id": "<CHỦ THỂ_ID>"
}
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.
THAM CHIẾU API

Đặc tả thực tế: Tạo chủ thể

POST · /v1/create/subject

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

POST /v1/create/subject. Tạo chủ thể loại PERSONAL hoặc ENTERPRISE trước khi bắt đầu các bước kiểm tra.

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.6.

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

{
  "owner_type": "PERSONAL",
  "personal_name": "<FULL_NAME>",
  "email": "<EMAIL>",
  "mobile": "<MOBILE>",
  "identity_document": {
    "type": "CITIZEN_CARD",
    "value": "<DOCUMENT_NUMBER>"
  }
}

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

{
  "x-subject-id": "<SUBJECT_ID>",
  "x-billcode-id": "<BILLCODE_ID>",
  "status": 201
}

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.