帳號授權

取得認證狀態

回傳帳號目前的認證流程狀態，包括 code、QR、密碼、Passkey、會話匯入或認證終態。Passkey 狀態包括 passkey_required、passkey_pending、passkey_confirmation 與 passkey_confirmation_sent；auth_payload 可能攜帶 WebAuthn public_key。

GEThttps://api.unifyport.ai/v1/accounts/{account_id}/auth

呼叫前準備

在伺服器端使用資源所屬工作區的 X-Api-Key，執行範例前替換所有預留位置。

參數從哪裡取得

account_id: 從建立或查詢帳號的回應取得 data.id。帳號屬於 X-Api-Key 對應的工作區。取得帳號

請求參數

請求標頭

X-Api-Key

string必填

工作區 API Key，工作區會由此標頭解析得到。

路徑參數

account_id

string必填

用於該 authentication 路由的識別字。

請求內容

此介面無需 JSON 請求內容。

如何理解結果

依文件解讀回應欄位與 HTTP 狀態。204 成功沒有回應本文，排查時使用 X-Request-Id。下一步請參閱相關操作。

回應 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "account_id": "acc_example",
    "status": "awaiting_qr_scan",
    "auth_fields": [
      {
        "type": "qr_code",
        "required": true
      }
    ],
    "auth_payload": {
      "qr_code": "https://example.com/qr"
    },
    "expires_at": "2026-01-01T00:00:00Z",
    "last_error": ""
  }
}

回應內容

account_id

string

本回應所對應的渠道帳號。

status

string

目前授權流程狀態，例如 pending_auth、awaiting_qr_scan、awaiting_code、pending、passkey_required、passkey_pending、passkey_confirmation、passkey_confirmation_sent、authorized 或 failed。

auth_fields[]

object[]

描述下一步驟所需的內容 — 每筆項目都帶有 type 以及是否為必填。

type

string

下一步認證要求的輸入類型，例如 code 或 password。

required

boolean

此認證輸入是否必須提供。

label

string

渠道方提供的輸入顯示標籤（如有）。

placeholder

string

渠道方提供的輸入預留位置提示（如有）。

auth_payload

object

目前步驟所需的標準載荷。普通 QR 使用 qr_code；驗證碼步驟使用 type=code；Passkey 使用 type=passkey 與 public_key。互斥步驟的載荷不會同時出現。

expires_at

string

RFC3339 時間戳記，超過後當前的 auth_payload 即失效。

format: date-time

last_error

string

最近一次認證錯誤；若無則為空字串。

回應

200

200 OK

請求成功，回應內容範例如上。

401

未授權

X-Api-Key 請求標頭缺少或無效。

500

伺服器錯誤

服務遇到了未預期的錯誤。

失敗後如何處理

檢查 HTTP 狀態和 error.code/numeric_code，保留 request_id。依原因修正參數、繼續授權或檢查狀態。重試傳送及寫入前確認上次結果，避免重複操作。錯誤碼參考

invalid_request · 10000 · 400: 檢查必填欄位、格式與渠道條件，修正請求後再呼叫。
invalid_api_key · 11001 · 401: 檢查 X-Api-Key 與工作區是否有效。