Use Recovery Code

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.

Uses the recovery code.

Membership · Passkey

post

Path parameters

VersionstringRequired

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

Body

Membership · Passkey

correlationIdstringOptional

CorrelationId for each request

cultureCodestringOptional

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

timeZoneIdstringOptional

TimeZone

versionstringRequired

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

envstringOptional

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.

emailstring · nullableOptional

recoveryCodestring · nullableOptional

Responses

200

Success

application/json

PasskeyRecoveryResponse

accessTokenstring · nullableOptional

refreshTokenstring · nullableOptional

expiresInSecondsinteger · int32Optional

remainingCodesinteger · int32Optional

post/{version}/membership/userauth/recovery/use-code

POST /{version}/membership/userauth/recovery/use-code HTTP/1.1
Host: api.norbix.ai
Content-Type: multipart/form-data
Accept: */*
Content-Length: 151

{
  "correlationId": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "env": "text",
  "projectId": "text",
  "email": "text",
  "recoveryCode": "text",
  "version": "text"
}

200

Success

{
  "accessToken": "text",
  "refreshToken": "text",
  "expiresInSeconds": 10,
  "remainingCodes": 10,
  "responseStatus": {
    "isSuccess": true
  }
}

In Cloud

Manage this visually in Cloud — see Membership.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Use Recovery Code in the SDK reference, with examples in every language.