Skip to main content
POST
/
v1
/
webauthn
/
register
/
start
C#
// POST /v1/webauthn/register/start
const stytch = require('stytch');

const client = new stytch.Client({
  project_id: '${projectId}',
  secret: '${secret}',
});

const params = {
  user_id: "${userId}",
  domain: "${exampleDomain}",
};

client.WebAuthn.RegisterStart(params)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });
{
  "request_id": "<string>",
  "user_id": "<string>",
  "public_key_credential_creation_options": "<string>",
  "status_code": 123
}
To optimize for Passkeys, set the return_passkey_credential_options field to true. After calling this endpoint, the browser will need to call navigator.credentials.create() with the data from public_key_credential_creation_options passed to the navigator.credentials.create() request via the public key argument. When using built-in browser methods like navigator.credentials.create(), set the use_base64_url_encoding option to true. See our WebAuthn setup guide for additional usage instructions and example code.

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Request type

​
user_id
string
required

The user_id of an active user the Passkey or WebAuthn registration should be tied to. You may use an external_id here if one is set for the user.

​
domain
string
required

The domain for Passkeys or WebAuthn. Defaults to window.location.hostname.

​
user_agent
string

The user agent of the client.

​
authenticator_type
string

The requested authenticator type of the Passkey or WebAuthn device. The two valid values are platform and cross-platform. If no value passed, we assume both values are allowed.

​
return_passkey_credential_options
boolean

If true, the public_key_credential_creation_options returned will be optimized for Passkeys with residentKey set to "required" and userVerification set to "preferred".

​
override_id
string
​
override_name
string
​
override_display_name
string
​
use_base64_url_encoding
boolean

If true, values in the public_key_credential_creation_options will be base64 URL encoded. Set this option to true when using built-in browser methods like navigator.credentials.create and navigator.credentials.get.

Response

Successful response

​
request_id
string
required

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.

​
user_id
string
required

The unique ID of the affected User.

​
public_key_credential_creation_options
string
required

Options used for Passkey or WebAuthn registration.

​
status_code
integer<int32>
required

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.