/
Contact usSee pricingStart building
    Introduction
    Overview
    Postman
    Organizations
      Organization object
      Create an organization
      Get an organization
      Update an organization
      Search for organizations
      Delete an organization
    Members
      Member object
      Create a Member
      Get a Member
      Get a Member (Dangerous)
      Update a Member
      Reactivate a Member
      Search for Members
      Unlink Retired Email

    • Delete

        • Delete a Member
        Delete Member password
        Delete Member MFA phone number
        Delete Member MFA TOTP
    RBAC
      Resource object
      Role object
      Scope object
      Get RBAC Policy
    Email magic links

    • Organization

        • Send login or signup email
        Send invite email
        Authenticate Magic Link

    • Discovery

        • Send discovery email
        Authenticate discovery Magic Link
    Email one-time passcodes (OTP)

    • Organization

        • Send login or signup OTP
        Authenticate OTP

    • Discovery

        • Send discovery OTP
        Authenticate discovery OTP
    OAuth

    • Discovery

        • Use Google for discovery
        Use Microsoft for discovery
        Use HubSpot for discovery
        Use Slack for discovery
        Use GitHub for discovery
        Authenticate discovery OAuth

    • Organization

        • Login with Google
        Login with Microsoft
        Login with HubSpot
        Login with Slack
        Login with GitHub
        Authenticate OAuth

    • Token

        • Get Google Access Token
        Get Microsoft Access Token
        Get HubSpot Access Token
        Get Slack Access Token
        Get GitHub Access Token
    Session management
      Session object
      Get JWKS
      Get Session
      Authenticate Session
      Exchange Session
      Revoke Session
      Migrate Session
    Single sign-on (SS0)
      SAML Connection object
      OIDC Connection object
      External Connection object

    • SAML

        • Create SAML Connection
        Update SAML Connection
        Update SAML Connection by Metadata URL
        Delete SAML Verification Certificate

    • OIDC

        • Create OIDC Connection
        Update OIDC Connection
        Get OIDC Access Token

    • External

        • Create External Connection
        Update External Connection

    • Shared

        • Get SSO Connections
        Delete SSO Connection
        Start SSO Authenticate
        Complete SSO Authenticate
    SCIM
      SCIM Connection Object

    • Connection management

        • Create SCIM Connection
        Update SCIM Connection
        Delete SCIM Connection
        Get SCIM Connection

    • Token management

        • Start SCIM Token Rotation
        Complete SCIM Token Rotation
        Cancel SCIM Token Rotation

    • SCIM groups

        • Get SCIM Connection Groups
    Discovery
      Discovered Organization object
      Create Organization via Discovery
      List Organizations
      Exchange Intermediate Session
    Passwords
      Authenticate
      Discovery Authenticate
      Strength check
      Migrate

    • Create or Reset Options

        • Password reset by email start
        Password reset by email
        Password reset by existing password
        Password reset by session
        Discovery Password reset by email start
        Discovery Password reset by email
        Require Password reset by email
    Multi-Factor Authentication (MFA)

    • One-time passcodes

        • Send SMS OTP
        Authenticate SMS OTP

    • Time-based one-time passcodes

        • Create TOTP
        Authenticate TOTP
        Migrate TOTP

    • Recovery codes

        • Get recovery codes
        Recover
        Rotate recovery codes
    M2M Authentication
      M2M Client Object

    • TOKEN

        • Get Access Token
        Authenticate Access Token

    • M2M Client

        • Create M2M client
        Get M2M client
        Search M2M clients
        Update M2M client
        Delete M2M client

    • Rotate secret

        • Start secret rotation
        Rotate secret
        Cancel secret rotation
    Connected AppsBeta
      Get Access Token

    • Tokens

        • Connected App ID Token Object
        Connected App Access Token Object

    • Configuration

        • Get JWKS
        Get OpenID Configuration

    • Methods

        • Introspect Token
        Authenticate Access Token (Local)
        Exchange Access Token
        Revoke Token
        Get UserInfo

    • Management

        • Dynamic Client Registration
        Get Authorized Connected Apps for an Organization
        Get Connected App Details
        Get Authorized Connected Apps for a Member
        Revoke Connected App Access to a Member
    Impersonation
      Authenticate Token
    Resources
      Organization authentication settings
      Common email domains
      Member states
      Email templates
      URL validation
      Metadata
      SAML overview
      SAML Certificates
    Errors
      Overview
      Error object
      400
      401
      403
      404
      405
      429
      499
      500
      503
Get support on SlackVisit our developer forum

Contact us

B2B Saas Authentication

/

API reference

/

Passwords

/

Create or Reset Options

/

Password reset by email start

Email reset start

POST
https://test.stytch.com/v1/b2b/passwords/email/reset/start

Initiates a password reset for the email address provided. This will trigger an email to be sent to the address, containing a magic link that will allow them to set a new password and authenticate.

This endpoint adapts to your Project's password strength configuration. If you're using zxcvbn, the default, your passwords are considered valid if the strength score is >= 3. If you're using LUDS, your passwords are considered valid if they meet the requirements that you've set with Stytch. You may update your password strength configuration in the stytch dashboard.

Body parameters

organization_id* string
email_address* string
reset_password_redirect_url string
login_redirect_url string
reset_password_template_id string
verify_email_template_id string
locale string
reset_password_expiration_minutes int
code_challenge string

Response fields

request_id string
status_code int
member_id string
member_email_id string
member object
const stytch = require('stytch');

const client = new stytch.B2BClient({
  project_id: 'PROJECT_ID',
  secret: 'SECRET',
});

const params = {
  organization_id: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
  email_address: "sandbox@stytch.com",
};

client.passwords.email.resetStart(params)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });
RESPONSE
200
​
{
  "status_code": 200,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "member_id": "member-test-32fc5024-9c09-4da3-bd2e-c9ce4da9375f",
  "member_email_id": "member-email-test-1dd089b3-8904-47ef-b943-987968e549d4",
  "member": {...}
}

Common Error Types

  • inactive_email
  • invalid_email
  • invalid_expiration
  • invalid_password_reset_redirect_url
  • invalid_pkce_code_challenge
  • no_password_reset_redirect_url
  • operation_restricted_by_organization_auth_methods
  • pkce_required_for_native_callback
  • retired_member_email