staqlydocs
REST APIAPI referenceAccounts

Start adding a passkey

Start adding a passkey

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

POST
/v1/account/sign-in-methods/passkey/start

Returns the options for navigator.credentials.create (a discoverable credential); passkeys the person has are excluded.

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Header Parameters

Idempotency-Key?string

Replays the stored response when the same key is repeated with the same method, path, query string and body within 24 hours (422 idempotency_mismatch with a different request, 409 idempotency_in_progress while the first one runs). Not applied to multipart uploads or to responses that carry a secret.

Lengthlength <= 200

Response Body

OK

application/json
  1. response
challenge_id*string

Send it back with the browser's answer

options*

WebAuthn options (PublicKeyCredentialCreationOptionsJSON or PublicKeyCredentialRequestOptionsJSON)

curl -X POST 'https://staqly.example.com/v1/account/sign-in-methods/passkey/start'
{  "challenge_id": "string",  "options": {}}