Stytch · Schema

api_b2b_recovery_codes_v1_RecoverResponse

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name	Type	Description
request_id	string	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
member_id	string	Globally unique UUID that identifies a specific Member.
member	object	The [Member object](https://stytch.com/docs/b2b/api/member-object)
organization	object	The [Organization object](https://stytch.com/docs/b2b/api/organization-object).
session_token	string	A secret token for a given Stytch Session.
session_jwt	string	The JSON Web Token (JWT) for a given Stytch Session.
recovery_codes_remaining	integer	The number of recovery codes remaining for a Member.
status_code	integer	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
member_session	object	The [Session object](https://stytch.com/docs/b2b/api/session-object).
member_device	object	If a valid `telemetry_id` was passed in the request and the [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) returned results, the `member_device` response field will con

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_b2b_recovery_codes_v1_RecoverResponse",
  "title": "api_b2b_recovery_codes_v1_RecoverResponse",
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string",
      "description": "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_id": {
      "type": "string",
      "description": "Globally unique UUID that identifies a specific Member."
    },
    "member": {
      "$ref": "#/components/schemas/api_organization_v1_Member",
      "description": "The [Member object](https://stytch.com/docs/b2b/api/member-object)"
    },
    "organization": {
      "$ref": "#/components/schemas/api_organization_v1_Organization",
      "description": "The [Organization object](https://stytch.com/docs/b2b/api/organization-object)."
    },
    "session_token": {
      "type": "string",
      "description": "A secret token for a given Stytch Session."
    },
    "session_jwt": {
      "type": "string",
      "description": "The JSON Web Token (JWT) for a given Stytch Session."
    },
    "recovery_codes_remaining": {
      "type": "integer",
      "format": "int32",
      "description": "The number of recovery codes remaining for a Member."
    },
    "status_code": {
      "type": "integer",
      "format": "int32",
      "description": "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."
    },
    "member_session": {
      "$ref": "#/components/schemas/api_b2b_session_v1_MemberSession",
      "description": "The [Session object](https://stytch.com/docs/b2b/api/session-object)."
    },
    "member_device": {
      "$ref": "#/components/schemas/api_device_history_v1_DeviceInfo",
      "description": "If a valid `telemetry_id` was passed in the request and the [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) returned results, the `member_device` response field will contain information about the member's device attributes."
    }
  },
  "required": [
    "request_id",
    "member_id",
    "member",
    "organization",
    "session_token",
    "session_jwt",
    "recovery_codes_remaining",
    "status_code"
  ]
}