POST
Set up a passkey (start)

Headers

x-program-id
string
required

Identifies the program. Can also be sent as the programId query parameter.

Origin
string

The origin your app runs on, e.g. https://app.example.com or http://localhost:3000. A passkey only works on the site or app that created it, so we read this to find which of your program's domains that is and build the challenge for it. It must match a configured origin exactly (scheme, host and port), or the call fails with 422 Origin not allowed. Browsers send it for you; native apps, scripts and Postman must set it themselves. To add an origin, ask your Orenda contact.

Body

application/json
session_token
string
required
Example:

"3f1c2e8a-9b4d-4e6f-8a1b-2c3d4e5f6a7b"

friendly_name
string

Optional label for the passkey, e.g. "My phone".

Response

WebAuthn creation options

success
boolean
Example:

true

data
object