Start passkey setup

POST

/api/v1/auth/setup/start

const url = 'https://example.com/api/v1/auth/setup/start';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"display_name":"example","token":"example","username":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/auth/setup/start \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "example", "token": "example", "username": "example" }'

Starts the passkey setup. A valid one-time setup token is required. A signed-in User is not needed. It can return 429 if the request limit is reached. Route: /api/v1/auth/setup/start. Inputs: . Do not automatically replay this operation after an uncertain result.

Request Body^required

application/json

object

display_name

required

string

token

string | null

username

required

string

Example^generated

{
  "display_name": "example",
  "token": "example",
  "username": "example"
}

Responses

200

Passkey challenge

429

application/json

object

code

required

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}

Start passkey setup

Request Bodyrequired

Examplegenerated

Responses

200

429

Examplegenerated

Request Body^required

Example^generated

Example^generated