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

# Get pending passkey pairing state

> Passkey pairing is initiated from the phone during QR login. When the phone requests it, the server sends a WebAuthn challenge which is stored here (also broadcast over the websocket as PASSKEY_REQUEST) until a response is submitted.




## OpenAPI

````yaml /openapi.yml get /app/passkey
openapi: 3.0.0
info:
  title: WhatsApp API MultiDevice
  version: 9.7.0
  description: |
    This API is used for sending whatsapp via API.

    The web dashboard is a separate project (gowa-ui); the server downloads its
    latest release asset and serves it at `/` (or returns a JSON banner when
    APP_UI_ENABLED=false).

    Device scoping:
    - Send `X-Device-Id` on all device-scoped REST calls.
    - WebSocket: connect to `/ws?device_id=<id>`.
    - WebSocket auth (when basic auth is enabled): browsers cannot set an
      Authorization header on WebSocket connections, so also pass
      `&authorization=<base64(user:pass)>` in the query string. Use TLS in
      production since the credential is visible in the URL.
servers:
  - url: http://localhost:3000
security:
  - basicAuth: []
tags:
  - name: app
    description: Initial Connection to Whatsapp server
  - name: device
    description: Device management for multi-device support
  - name: user
    description: Getting information
  - name: send
    description: Send Message (Text/Image/File/Video).
  - name: message
    description: Message manipulation (revoke/react/update).
  - name: call
    description: Call management (reject incoming calls)
  - name: chat
    description: Chat conversations and messaging
  - name: group
    description: Group setting
  - name: newsletter
    description: newsletter setting
  - name: chatwoot
    description: Chatwoot integration for customer support
paths:
  /app/passkey:
    get:
      tags:
        - app
      summary: Get pending passkey pairing state
      description: >
        Passkey pairing is initiated from the phone during QR login. When the
        phone requests it, the server sends a WebAuthn challenge which is stored
        here (also broadcast over the websocket as PASSKEY_REQUEST) until a
        response is submitted.
      operationId: appPasskeyStatus
      parameters:
        - $ref: '#/components/parameters/DeviceIdHeader'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasskeyStatusResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInternalServer'
components:
  parameters:
    DeviceIdHeader:
      name: X-Device-Id
      in: header
      required: false
      description: >
        Device identifier for multi-device support. Required when multiple
        devices are registered.

        If only one device is registered, it will be used as the default.

        Can also be provided as `device_id` query parameter.
      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 assertion request options
                (PublicKeyCredentialRequestOptions JSON, base64url-encoded
                binary fields)
              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: Pairing confirmation code (set while awaiting confirmation)
              example: ABCD-EFGH
            skip_handoff_ux:
              type: boolean
              example: false
    ErrorInternalServer:
      type: object
      properties:
        code:
          type: string
          example: INTERNAL_SERVER_ERROR
          description: SYSTEM_CODE_ERROR
        message:
          type: string
          example: you are not loggin
          description: Detail error message
        results:
          type: object
          example: null
          description: additional data
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

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