Sign in
📱 Pairing

Get the pending passkey (WebAuthn) challenge.

Available while the session is in PASSKEY_REQUIRED status. Pass the challenge to navigator.credentials.get({ publicKey: challenge }) on the https://web.whatsapp.com origin.

get/api/{session}/auth/passkey/challenge

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/{session}/auth/passkey/challenge
  • Auth: API key in header X-Api-Key

Path parameters

sessionstring required

Session name

Response

challengestring required

Base64url-encoded challenge to sign.

timeoutnumber required

How long the challenge is valid for, in milliseconds.

rpIdstring required

Relying party ID.

userVerificationstring required
extensionsobject

WebAuthn extensions requested by WhatsApp.

Example response

{
  "timeout": 60000,
  "rpId": "web.whatsapp.com",
  "allowCredentials": [
    {
      "type": "public-key",
      "transports": [
        "internal",
        "hybrid"
      ]
    }
  ],
  "userVerification": "required"
}

Changes

No recorded changes to this operation across all 1 revision of this API.