STstytch
B2B Totp

Migrate

Changed on

Migrate an existing TOTP instance for a Member. Recovery codes are not required and will be minted for the Member if not provided.

post/v1/b2b/totp/migrate

Request

  • Base URL
    https://api.stytch.com
  • Auth
    HTTP basic

Request body

organization_idstring required

Globally unique UUID that identifies a specific Organization. The organization_id is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.

member_idstring required

Globally unique UUID that identifies a specific Member. The member_id is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.

secretstring required

The TOTP secret key shared between the authenticator app and the server used to generate TOTP codes.

recovery_codesstring[] required

An existing set of recovery codes to be imported into Stytch to be used to authenticate in place of the secondary MFA method.

Response

Successful response

request_idstring required

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.

member_idstring required

Globally unique UUID that identifies a specific Member.

totp_registration_idstring required

The unique ID for a TOTP instance.

recovery_codesstring[] required

An array of recovery codes that can be used to recover a Member's account.

status_codeinteger required

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.

Changes