> ## Documentation Index
> Fetch the complete documentation index at: https://gowa-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 保留中のパスキーペアリング状態を取得する

> QRログイン中に携帯電話からパスキーのペアリングが開始されます。 電話がリクエストした時 サーバは WebAuthn チャレンジをここに送信し、応答が送信されるまで (PASSKEY_REQUESTとしてウェブソケット上でもブロードキャストされます)。




## OpenAPI

````yaml /ja/openapi.yml get /app/passkey
openapi: 3.0.0
info:
  title: WhatsApp API マルチデバイス
  version: 9.7.0
  description: |
    この API は API 経由で whatsapp を送信するために使用されます。

    Web ダッシュボードは別のプロジェクトです (gowa-ui); サーバーは
    最新のリリースアセットをダウンロードし、`/`で動作します（または、
    APP_UI_ENABLED=falseの場合はJSONバナーを返します）。

    デバイススコープ:
    - すべてのデバイススコープの REST コールで `X-Device-Id` を送信します。
    - WebSocket: `/wsに接続しますか？device_id=<id> ` 。
    - WebSocket 認証（Basic Auth が有効な場合）: ブラウザーは WebSocket 接続で
      Authorization ヘッダーを設定できないため、クエリ文字列にも
      `&authorization=<base64(user:pass)>` を渡してください。 認証情報が URL に表示されるため、本番環境では
      TLS を使用してください。
servers:
  - url: http://localhost:3000
security:
  - basicAuth: []
tags:
  - name: app
    description: Whatsappサーバーへの初期接続
  - name: device
    description: マルチデバイスサポートのためのデバイス管理
  - name: user
    description: 情報の取得
  - name: send
    description: メッセージ (テキスト/イメージ/ファイル/ビデオ) を送信します。
  - name: message
    description: メッセージ操作 (revoke/react/update)
  - name: call
    description: 通話管理 (着信拒否)
  - name: chat
    description: チャットとメッセージ
  - name: group
    description: グループ設定
  - name: newsletter
    description: ニュースレターの設定
  - name: chatwoot
    description: カスタマーサポートのためのChatwoot統合
paths:
  /app/passkey:
    get:
      tags:
        - app
      summary: 保留中のパスキーペアリング状態を取得する
      description: >
        QRログイン中に携帯電話からパスキーのペアリングが開始されます。 電話がリクエストした時 サーバは WebAuthn
        チャレンジをここに送信し、応答が送信されるまで (PASSKEY_REQUESTとしてウェブソケット上でもブロードキャストされます)。
      operationId: appPasskeyStatus
      parameters:
        - $ref: '#/components/parameters/DeviceIdHeader'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasskeyStatusResponse'
        '500':
          description: 内部サーバーエラー
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInternalServer'
components:
  parameters:
    DeviceIdHeader:
      name: X-Device-Id
      in: header
      required: false
      description: |
        マルチデバイスサポート用のデバイス識別子 複数のデバイスが登録されている場合に必要です。
        1つのデバイスのみ登録されている場合は、デフォルトとして使用されます。
        `device_id`クエリパラメータとして提供することもできます。
      schema:
        type: string
        example: my-device-id
  schemas:
    PasskeyStatusResponse:
      type: object
      properties:
        code:
          type: string
          example: SUCCESS
        message:
          type: string
          example: Passkey pairing status
        results:
          type: object
          properties:
            device_id:
              type: string
              example: device-1
            status:
              type: string
              enum:
                - none
                - awaiting_response
                - awaiting_confirmation
              example: awaiting_response
            challenge:
              type: object
              nullable: true
              description: >-
                WebAuthn アサーションのリクエストオプション(公開鍵CredentialRequestOptions JSON,
                base64urlエンコードされたバイナリフィールド)
              properties:
                challenge:
                  type: string
                  example: dGVzdC1jaGFsbGVuZ2U
                timeout:
                  type: integer
                  example: 60000
                rpId:
                  type: string
                  example: whatsapp.com
                allowCredentials:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      type:
                        type: string
                        example: public-key
                      transports:
                        type: array
                        items:
                          type: string
                userVerification:
                  type: string
                  example: required
            code:
              type: string
              description: 確認コードをペアリングしています（確認を待っている間に設定してください）
              example: ABCD-EFGH
            skip_handoff_ux:
              type: boolean
              example: false
    ErrorInternalServer:
      type: object
      properties:
        code:
          type: string
          example: INTERNAL_SERVER_ERROR
          description: システムのコードにエラー
        message:
          type: string
          example: you are not loggin
          description: 詳細エラーメッセージ
        results:
          type: object
          example: null
          description: 追加データ
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

## Related topics

- [パスキーのペアリングのための WebAuthn アサーションを送信](https://gowa-docs.mintlify.site/ja/api-reference/app/パスキーのペアリングのための-webauthn-アサーションを送信.md)
- [WebSocketイベント](https://gowa-docs.mintlify.site/ja/api-reference/websocket.md)
- [パスキーのペアリングコードを確認する](https://gowa-docs.mintlify.site/ja/api-reference/app/パスキーのペアリングコードを確認する.md)
- [ペアリングコードでデバイスにログイン](https://gowa-docs.mintlify.site/ja/api-reference/device/ペアリングコードでデバイスにログイン.md)
- [端末の接続状態を取得する](https://gowa-docs.mintlify.site/ja/api-reference/device/端末の接続状態を取得する.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.