Stytch · Schema

api_otp_v1_AuthenticateResponse

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
user_id	string	The unique ID of the affected User.
method_id	string	The `email_id` or `phone_id` involved in the given authentication.
session_token	string	A secret token for a given Stytch Session.
session_jwt	string	The JSON Web Token (JWT) for a given Stytch Session.
user	object	The `user` object affected by this API call. See the [Get user endpoint](https://stytch.com/docs/api/get-user) for complete response field details.
reset_sessions	boolean	Indicates if all other of the User's Sessions need to be reset. You should check this field if you aren't using Stytch's Session product. If you are using Stytch's Session product, we revoke the User'
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
session	object	If you initiate a Session, by including `session_duration_minutes` in your authenticate call, you'll receive a full Session object in the response. See [Session object](https://stytch.com/docs/api/ses
user_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 `user_device` response field will conta

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_otp_v1_AuthenticateResponse",
  "title": "api_otp_v1_AuthenticateResponse",
  "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."
    },
    "user_id": {
      "type": "string",
      "description": "The unique ID of the affected User."
    },
    "method_id": {
      "type": "string",
      "description": "The `email_id` or `phone_id` involved in the given authentication."
    },
    "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."
    },
    "user": {
      "$ref": "#/components/schemas/api_user_v1_User",
      "description": "The `user` object affected by this API call. See the [Get user endpoint](https://stytch.com/docs/api/get-user) for complete response field details."
    },
    "reset_sessions": {
      "type": "boolean",
      "description": "Indicates if all other of the User's Sessions need to be reset. You should check this field if you aren't using Stytch's Session product. If you are using Stytch's Session product, we revoke the User's other sessions for you."
    },
    "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."
    },
    "session": {
      "$ref": "#/components/schemas/api_session_v1_Session",
      "description": "If you initiate a Session, by including `session_duration_minutes` in your authenticate call, you'll receive a full Session object in the response.\n\n  See [Session object](https://stytch.com/docs/api/session-object) for complete response fields.\n  "
    },
    "user_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 `user_device` response field will contain information about the user's device attributes."
    }
  },
  "required": [
    "request_id",
    "user_id",
    "method_id",
    "session_token",
    "session_jwt",
    "user",
    "reset_sessions",
    "status_code"
  ]
}