reset_password_action

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/riskified/main/json-schema/riskified-reset-password-action-schema.json",
  "title": "reset_password_action",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/riskified-account-secure-openapi.yml#/components/schemas/reset_password_action",
  "type": "object",
  "properties": {
    "customer_id": {
      "type": "string",
      "description": "A unique numeric identifier for the customer."
    },
    "email": {
      "type": "string",
      "description": "The email address on the registered customer account."
    },
    "status": {
      "type": "string",
      "description": "Indicates the status of the request.\n\n**Possible values:**\n- `pending`: Password reset has been requested but new password has not been set\n- `success`: Password has successfully been reset and old password is no longer valid\n- `failed`: Password failed to be reset and old password is still valid",
      "enum": [
        "pending",
        "success",
        "failed"
      ]
    },
    "reason": {
      "type": "string",
      "description": "The reason for the password reset request.\n\n**Possible values:**\n- `user_requested`: Customer is logged in and initiates a password change from their account\n- `forgot_password`: Customer has forgotten password and directly initiates process to create a new password\n- `forced_reset`: An internal system-initiated password reset request",
      "enum": [
        "user_requested",
        "forgot_password",
        "forced_reset"
      ]
    },
    "client_details": {
      "$ref": "#/$defs/client_details",
      "description": "An object containing technical information regarding the customer’s browsing session."
    },
    "session_details": {
      "$ref": "#/$defs/session_details",
      "description": "An object containing basic information regarding the session."
    },
    "vendor_name": {
      "type": "string",
      "description": "The name of the affiliated partner or selling vendor."
    }
  },
  "required": [
    "customer_id",
    "status",
    "reason",
    "email",
    "client_details",
    "session_details"
  ],
  "$defs": {
    "client_details": {
      "type": "object",
      "description": "An object containing technical information regarding the customer’s browsing session",
      "properties": {
        "user_agent": {
          "type": "string",
          "description": "The full User-Agent sent from the client."
        },
        "accept_language": {
          "type": "string",
          "description": "List of two-letter language codes sent from the client."
        }
      },
      "required": [
        "user_agent",
        "accept_language"
      ]
    },
    "session_details": {
      "type": "object",
      "description": "An object containing basic information regarding the session.\n\nSession data points, such as `cart_token`, `browser_ip`, and `user_agent`, should be those associated with values at the time of user's login request - **before** the authentication result is available.",
      "properties": {
        "cart_token": {
          "type": "string",
          "description": "The session id at the time that the user is on the login webpage or started password reset, prior to authentication attempt.\nMust match the `session_details.cart_token` value set by the Beacon JavaScript snippet. For standard integrations, this value is automatically generated by Beacon. For merchants who manage their own sessions, the same session ID must be passed to both the Beacon and this field. Must remain consistent throughout a purchase flow. Max 100 characters."
        },
        "browser_ip": {
          "type": "string",
          "description": "The customer's browser IP address during the session."
        },
        "created_at": {
          "type": "string",
          "description": "The date and time (ISO8601) of the session."
        },
        "source": {
          "type": "string",
          "enum": [
            "desktop_web",
            "mobile_web",
            "web",
            "mobile_app",
            "other"
          ],
          "description": "The platform that the session originated from.\n\n**Possible values:**\n- `desktop_web`: Session originated on the website, using a desktop device\n- `mobile_web`: Session originated on the mobile website, using a mobile device\n- `web`: Session originated on the website, with no available info about the type of device used\n- `mobile_app`: Session originated on the mobile app, using a mobile device\n- `other`: The session's origin is unknown"
        },
        "device_id": {
          "type": "string",
          "description": "**(Conditional Requirement)** Required for mobile applications. The mobile device identifier, which corresponds to a value extracted via the Riskified mobile beacon SDK."
        },
        "referring_site": {
          "type": "string",
          "description": "**(Strongly Recommended)** The webpage from which the customer accessed the shop. Domain level is enough, and usually set the shop_url provided by Riskified. In case you have several sites may be used by different population, set different url per the scenario (e.g. regular ec-site: www.shop-regular.com, employee ec-site: www.shop-employee.com)"
        }
      },
      "required": [
        "created_at",
        "cart_token",
        "browser_ip",
        "source"
      ]
    }
  }
}