ปลายทางสำหรับตรวจสอบผู้ใช้เพื่อขอข้อมูลเข้าสู่ระบบดิจิทัล โดยใช้รายการหลักฐานที่ผู้ออกข้อมูลเข้าสู่ระบบระบุ และสำหรับอุปกรณ์ที่เฉพาะเจาะจง
คำขอ HTTP
POST https://example.issuer.com/api/v1/vdc/proofUser
เนื้อหาคำขอ
เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
| การแสดง JSON |
|---|
{ "requestMetadata": { object ( |
| ช่อง | |
|---|---|
requestMetadata |
ต้องระบุ ข้อมูลเมตาเกี่ยวกับคำขอ ซึ่งจำเป็นในคำขอทั้งหมด |
deviceReferenceId |
ต้องระบุ รหัสที่ตรงกับอุปกรณ์และคีย์ประจำตัวที่เชื่อมโยงกับอุปกรณ์ รหัสนี้ไม่ใช่รหัสอุปกรณ์ ซึ่งหมายความว่าหากผู้ใช้มีข้อมูลเข้าสู่ระบบ 2 รายการแยกกันในอุปกรณ์เครื่องเดียวกัน รหัสนี้จะแตกต่างกัน ระบบจะระบุรหัสนี้ในคำขอทั้งหมด และคุณสามารถใช้รหัสนี้เพื่อเชื่อมโยงคำขอต่างๆ ได้ |
proofingId |
ต้องระบุ ตัวระบุแบบทึบแสงที่แสดงการตรวจสอบด้วยชุดหลักฐานที่เฉพาะเจาะจงสำหรับอุปกรณ์ที่เฉพาะเจาะจง เช่น UUID |
evidence[] |
ต้องระบุ รายการหลักฐานที่จำเป็นในการตรวจสอบผู้ใช้เพื่อขอข้อมูลเข้าสู่ระบบดิจิทัล |
ฟิลด์ Union proofing_context บริบทสำหรับการตรวจสอบ เว้นว่างไว้สำหรับการตรวจสอบครั้งแรก proofing_context ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
reverificationContext |
บริบทสำหรับการตรวจสอบซ้ำ |
เนื้อหาการตอบกลับ
การรับทราบคำขอตรวจสอบผู้ใช้เพื่อขอข้อมูลเข้าสู่ระบบดิจิทัล ซึ่งบ่งบอกว่าระบบกำลังประมวลผลการตรวจสอบ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
| การแสดง JSON |
|---|
{
"responseMetadata": {
object ( |
| ช่อง | |
|---|---|
responseMetadata |
ต้องระบุ ข้อมูลเมตาเกี่ยวกับการตอบกลับ ซึ่งจำเป็นในการตอบกลับทั้งหมด |
proofingId |
ต้องระบุ ตัวระบุแบบทึบแสงที่แสดงการตรวจสอบด้วยชุดหลักฐานที่เฉพาะเจาะจงสำหรับอุปกรณ์ที่เฉพาะเจาะจง นี่คือรหัสการตรวจสอบเดียวกันกับที่ส่งในคำขอ |
ProofingEvidence
ออบเจ็กต์ที่แสดงหลักฐานชิ้นเดียว
| การแสดง JSON |
|---|
{ // Union field |
| ช่อง | |
|---|---|
ฟิลด์ Union evidence_type ต้องระบุ Oneof ที่ระบุวิธีนำเสนอหลักฐาน evidence_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
preAuthorizationCode |
รหัสการให้สิทธิ์ล่วงหน้าที่ส่งจากผู้ออกบัตร |
หลักฐาน
ออบเจ็กต์ที่แสดงหลักฐานชิ้นเดียว
| การแสดง JSON |
|---|
{ // Union field |
| ช่อง | |
|---|---|
ฟิลด์ Union presencetype ต้องระบุ Oneof ที่ระบุวิธีนำเสนอหลักฐาน presencetype ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
encryptedData |
ค่าที่เข้ารหัสและข้อมูลเมตาการเข้ารหัสที่จำเป็นในการถอดรหัสค่า |
unencryptedValue |
ค่าหลักฐานที่เข้ารหัสฐาน 64 |
unencryptedInteger |
ค่าจำนวนเต็มของหลักฐาน |
ReverificationContext
บริบทที่จำเป็นในการทริกเกอร์การตรวจสอบซ้ำสำหรับข้อมูลเข้าสู่ระบบ
| การแสดง JSON |
|---|
{ "credentialId": string } |
| ช่อง | |
|---|---|
credentialId |
ต้องระบุ รหัสข้อมูลเข้าสู่ระบบที่จะทำการตรวจสอบซ้ำ |