Skip to main content
POST
/
v1
/
totps
/
recovery_codes
C#
// POST /v1/totps/recovery_codes
const stytch = require('stytch');

const client = new stytch.Client({
  project_id: '${projectId}',
  secret: '${secret}',
});

const params = {
  user_id: "${userId}",
};

client.TOTPs.RecoveryCodes(params)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });
{
  "request_id": "<string>",
  "user_id": "<string>",
  "totps": [
    {
      "totp_id": "<string>",
      "verified": true,
      "recovery_codes": [
        "<string>"
      ]
    }
  ],
  "status_code": 123
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Request type

​
user_id
string
required

The user_id of an active user the TOTP registration should be tied to. You may use an external_id here if one is set for the user.

Response

Successful response

​
request_id
string
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.

​
user_id
string
required

The unique ID of the affected User.

​
totps
object[]
required

An array containing a list of all TOTP instances (along with their recovery codes) for a given User in the Stytch API.

​
status_code
integer<int32>
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.