Passkey Registration Options

Membership · Passkey.

These endpoints power passwordless sign-in (passkeys / WebAuthn) and account recovery (magic links, recovery codes, email verification) for your app's end users.

Handles the registration options.

Membership · Passkey

post

Path parameters

versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Body

multipart/form-dataapplication/json

Membership · Passkey

correlationIdstring · nullableOptional

CorrelationId for each request

cultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

timeZoneIdstring · nullableOptional

TimeZone

envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

projectIdstringRequired

ID of your project. Can be passed in a header as norbix-project-id.

verificationTokenstringOptional

Responses

200

OK

application/json

ceremonyIdstring · nullableOptional

optionsJsonstring · nullableOptional

post/{version}/membership/userauth/passkey/registration-options

HTTPcURLJavaScriptPython

POST /{version}/membership/userauth/passkey/registration-options HTTP/1.1
Host: api.norbix.ai
Content-Type: multipart/form-data
Accept: */*
Content-Length: 124

{
  "correlationId": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "env": "text",
  "projectId": "text",
  "verificationToken": "text"
}

multipart/form-dataapplication/json

200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "ceremonyId": "text",
  "optionsJson": "text"
}

In the dashboard

Manage this visually in Norbix Cloud — see Membership.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Passkey Registration Options in the SDK reference, with examples in every language.