Recover a user

Completes the process of recovering a user by adding an authenticator

POST

/

public

/

v1

/

submit

/

recover_user

Authorizations

API Key

X-Stamp

string

header

required

X-Stamp

string

header

required

X-Stamp-Webauthn

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_RECOVER_USER

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

parameters field

Show details

parameters.authenticator · object · required

authenticator field

Show details

parameters.authenticator.authenticatorName

string

required

Human-readable name for an Authenticator.

parameters.authenticator.challenge

string

required

Challenge presented for authentication purposes.

parameters.authenticator.attestation · object · required

attestation field

Show details

parameters.authenticator.attestation.credentialId

string

required

The cbor encoded then base64 url encoded id of the credential.

parameters.authenticator.attestation.clientDataJson

string

required

A base64 url encoded payload containing metadata about the signing context and the challenge.

parameters.authenticator.attestation.attestationObject

string

required

A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.

parameters.authenticator.attestation.transports

enum<string[]>

required

Enum options: AUTHENTICATOR_TRANSPORT_BLE, AUTHENTICATOR_TRANSPORT_INTERNAL, AUTHENTICATOR_TRANSPORT_NFC, AUTHENTICATOR_TRANSPORT_USB, AUTHENTICATOR_TRANSPORT_HYBRID

parameters.userId

string

required

Unique identifier for the user performing recovery.

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.recoverUserIntent

object

required

The recoverUserIntent object

Show recoverUserIntent details

activity.intent.recoverUserIntent.authenticator

object

required

authenticator field

Show authenticator details

activity.intent.recoverUserIntent.authenticator.authenticatorName

string

required

Human-readable name for an Authenticator.

activity.intent.recoverUserIntent.authenticator.challenge

string

required

Challenge presented for authentication purposes.

activity.intent.recoverUserIntent.authenticator.attestation

object

required

attestation field

Show attestation details

activity.intent.recoverUserIntent.authenticator.attestation.credentialId

string

required

The cbor encoded then base64 url encoded id of the credential.

activity.intent.recoverUserIntent.authenticator.attestation.clientDataJson

string

required

A base64 url encoded payload containing metadata about the signing context and the challenge.

activity.intent.recoverUserIntent.authenticator.attestation.attestationObject

string

required

A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.

activity.intent.recoverUserIntent.authenticator.attestation.transports

array

required

The type of authenticator transports.

Show transports details

activity.intent.recoverUserIntent.authenticator.attestation.transports.item

enum

required

item field

Enum options: AUTHENTICATOR_TRANSPORT_BLE, AUTHENTICATOR_TRANSPORT_INTERNAL, AUTHENTICATOR_TRANSPORT_NFC, AUTHENTICATOR_TRANSPORT_USB, AUTHENTICATOR_TRANSPORT_HYBRID

activity.intent.recoverUserIntent.userId

string

required

Unique identifier for the user performing recovery.

activity.result

object

required

The result of the activity

Show result details

activity.result.recoverUserResult

object

required

The recoverUserResult object

Show recoverUserResult details

activity.result.recoverUserResult.authenticatorId

array

required

ID of the authenticator created.

Show authenticatorId details

activity.result.recoverUserResult.authenticatorId.item

string

required

item field

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/recover_user \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_RECOVER_USER",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "authenticator": {
            "authenticatorName": "<string>",
            "challenge": "<string>",
            "attestation": {
                "credentialId": "<string>",
                "clientDataJson": "<string>",
                "attestationObject": "<string>",
                "transports": [
                    "<AUTHENTICATOR_TRANSPORT_BLE>"
                ]
            }
        },
        "userId": "<string>"
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_RECOVER_USER",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "recoverUserIntent": {
            "authenticator": {
              "authenticatorName": "<string>",
              "challenge": "<string>",
              "attestation": {
                "credentialId": "<string>",
                "clientDataJson": "<string>",
                "attestationObject": "<string>",
                "transports": [
                  "<AUTHENTICATOR_TRANSPORT_BLE>"
                ]
              }
            },
            "userId": "<string>"
          }
        },
        "result": {
          "recoverUserResult": {
            "authenticatorId": [
              "<string_element>"
            ]
          }
        }
      }
    }
  }
}