Get MFA status

Get the MFA status of an activity for a specific user or all voting users.

organizationId · string · required

Unique identifier for a given organization.

activityId · string · required

The unique identifier of the activity to get MFA status for.

userId · string

Optional user ID to filter MFA status for a specific user.

A successful response returns the following fields:

mfaStatuses · array · required

A list of MFA statuses for the activity’s votes.

Show mfaStatuses details

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_mfa_status \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "activityId": "<string>",
    "userId": "<string>"
}'

import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().getMfaStatus({
  organizationId: "<string> (Unique identifier for a given organization.)",
  activityId: "<string> (The unique identifier of the activity to get MFA status for.)",
  userId: "<string> (Optional user ID to filter MFA status for a specific user.)"
});

200

{
  "mfaStatuses": [
    {
      "mfaPolicyId": "<string>",
      "userId": "<string>",
      "satisfied": "<boolean>",
      "satisfiedMethods": [
        {
          "type": "<AUTHENTICATION_TYPE_EMAIL_OTP>",
          "id": "<string>"
        }
      ],
      "requiredMethods": [
        {
          "any": [
            {
              "type": "<AUTHENTICATION_TYPE_EMAIL_OTP>",
              "id": "<string>"
            }
          ]
        }
      ]
    }
  ]
}