เริ่มต้นใช้งาน
ข้อมูลหลัก
อื่นๆ

ผลการยืนยันผ่าน Status API

พาร์ทเนอร์สามารถตรวจสอบสถานะการยืนยันผ่าน API endpoint สถานะการยืนยันของเรา (GET /api/partner/v2/verify/requests/{id}) endpoint นี้จะส่งคืนทั้งผลการยืนยันและข้อมูลรับรองสำหรับคำขอการยืนยันที่ระบุ
การตรวจสอบสิทธิ์ต้องใช้โทเค็น JWT จาก endpoint ของโทเค็น OAuth ของเรา และ API ต้องใช้รหัสคำขอที่สร้างขึ้นเมื่อมีการส่งคำขอการยืนยันในตอนแรก

สถานะ

สถานะคำอธิบาย
incompleteการยืนยันอยู่ระหว่างดำเนินการ ยังไม่มีผลการยืนยันในขั้นตอนนี้
canceledการยืนยันไม่ได้ดำเนินการต่อและไม่มีผลการยืนยัน
verifiedการยืนยันเสร็จสมบูรณ์และมีผลการยืนยัน
revokedผลการยืนยันไม่ถูกต้อง ควรลบสำเนาผลการยืนยันทั้งหมด
unsharedไม่มีผลการยืนยัน กรณีนี้จะเกิดขึ้นเมื่อผู้ใช้ขอให้ยุติการแชร์ หรือยังไม่ได้ให้ความยินยอมในการแชร์เอกสารที่อัปเดต
กรุณาอ้างอิงจาก OpenAPI Specification V2 ของเราสำหรับรายละเอียดเพิ่มเติมเกี่ยวกับรูปแบบคำขอและการตอบกลับ

ตัวอย่างคำขอ

ตัวอย่างผลการยืนยัน: ข้อมูลที่ยืนยันแล้ว
# GET /api/partner/v2/verify/requests/7cbc7e51-82f5-43ec-8d63-b7cdf1170425

{
  "request_id": "7cbc7e51-82f5-43ec-8d63-b7cdf1170425",
  "created_at": "2026-03-11T23:44:03.863583Z",
  "results": [
    {
      "credential_type": "digital_identity",
      "status": "verified",
      "verified_at": "2026-03-12T00:27:46.657218Z",
      "digital_identity": {
        "full_name": "John Smith"
      }
    }
  ]
}
ตัวอย่างผลการยืนยัน: การยืนยันไม่สมบูรณ์
{
  "request_id": "9a98ba28-cd63-43d4-9959-9c593700c7da",
  "created_at": "2026-01-20T02:43:09.440220Z",
  "results": [
    {
      "credential_type": "digital_identity",
      "status": "incomplete"
    }
  ]
}
ตัวอย่างผลการยืนยัน: การยืนยันถูกยกเลิก
{
  "request_id": "793a798c-92ac-4b5f-9866-ef73e6b4c6d9",
  "created_at": "2026-01-20T02:43:09.440220Z",
  "results": [
    {
      "credential_type": "digital_identity",
      "status": "canceled"
    }
  ]
}

Bulk Status API

มี Bulk Status API ให้ใช้งานด้วยสำหรับการค้นหาสถานะของคำขอการยืนยันหลายรายการพร้อมกัน สามารถรวม request ID ได้สูงสุด 30 รายการในหนึ่งคิวรี
# GET /api/partner/v2/verify/requests?request_id[]=25055614-f707-47cc-b7ed-1724c04dcd05&request_id[]=9a98ba28-cd63-43d4-9959-9c593700c7da
{
  "requests": [
    {
      "request_id": "9a98ba28-cd63-43d4-9959-9c593700c7da",
      "created_at": "2026-01-20T02:43:09.440220Z",
      "results": [
        {
          "credential_type": "digital_identity",
          "status": "incomplete"
        }
      ]
    },
    {
      "request_id": "25055614-f707-47cc-b7ed-1724c04dcd05",
      "created_at": "2025-12-18T06:34:34.338171Z",
      "results": [
        {
          "credential_type": "digital_identity",
          "status": "verified",
          "verified_at": "2025-12-18T07:26:01.571197Z",
          "digital_identity": {
            "full_name": "John Smith"
          }
        }
      ]
    }
  ]
}

ทดสอบขั้นตอนการยืนยัน

พาร์ทเนอร์ที่เปิดใช้งานการทดสอบสามารถทดสอบขั้นตอนการยืนยันในสภาพแวดล้อม staging โดยใช้ผลลัพธ์ที่กำหนดไว้ล่วงหน้า กำหนด display_options.partner_name เป็นหนึ่งในค่าทดสอบที่รองรับด้านล่าง ค่า NZDL ที่แสดงเป็นเพียงตัวอย่าง
สถานการณ์ทดสอบตัวอย่างค่า partner_nameผลลัพธ์ที่คาดหวัง
ยืนยันแล้วPartner.Verified.NZDLสำหรับตัวอย่างนี้ API สถานะจะส่งคืน incomplete ในขณะที่อยู่ระหว่างดำเนินการตามขั้นตอนการยืนยัน หลังจากดำเนินการเสร็จสิ้น จะส่งคืน verified
ยกเลิกแล้วPartner.Canceled.NZDLสำหรับตัวอย่างนี้ คำขอจะถูกยกเลิกทันที API สถานะจะส่งคืน canceled และ SEEK Pass จะส่งเหตุการณ์ webhook ว่าถูกยกเลิกแล้ว
คำขอต่อไปนี้ใช้ค่า NZDL ที่ยืนยันแล้วเป็นตัวอย่าง:
# POST /api/partner/v2/verify/requests/digital_identity.json
{
  "display_options": {
    "partner_name": "Partner.Verified.NZDL"
  }
}
สำหรับผลลัพธ์ที่ได้รับการยืนยัน ให้เปิด redirect_uri ที่ส่งกลับมาในการตอบกลับและดำเนินการตามขั้นตอนให้เสร็จสิ้น จากนั้นใช้รหัสคำขอเพื่อตรวจสอบผลลัพธ์:
GET /api/partner/v2/verify/requests/{id}
นอกจากนี้ SEEK Pass ยังส่งเหตุการณ์ webhook เมื่อผลการทดสอบพร้อมใช้งาน สำหรับข้อมูลเพิ่มเติม ดูที่ ผลการยืนยันผ่าน Webhooks