Class: Stytch::Fraud::Email

Inherits:

Object

• Object
• Stytch::Fraud::Email

Includes:

RequestHelper

Defined in:

lib/stytch/fraud.rb

Instance Method Summary

• #initialize(connection) ⇒ Email constructor

  A new instance of Email.

• #risk(email_address:) ⇒ Object

  Get risk information for a specific email address.

Methods included from RequestHelper

#delete_request, #get_request, #post_request, #put_request, #request_with_query_params

Constructor Details

#initialize(connection) ⇒ Email

Returns a new instance of Email.

# File 'lib/stytch/fraud.rb', line 344

def initialize(connection)
  @connection = connection
end

Instance Method Details

#risk(email_address:) ⇒ Object

Get risk information for a specific email address. The response will contain a recommended action (‘ALLOW`, `BLOCK`, or `CHALLENGE`) and a more granular `risk_score`. You can also check the `address_information` and `domain_information` fields for more information about the email address and email domain.

This feature is in beta. Reach out to us [here](fraud-team@stytch.com?subject=Email_Intelligence_Early_Access) if you’d like to request early access.

Parameters:

email_address

The email address to check. The type of this field is String.

Returns:

An object with the following fields:

request_id

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. The type of this field is String.

address_information

Information about the email address. The type of this field is AddressInformation (object).

domain_information

Information about the email domain. The type of this field is DomainInformation (object).

action

The suggested action based on the attributes of the email address. The available actions are:

• ‘ALLOW` - This email is most likely safe to send to and not fraudulent.

• ‘BLOCK` - This email is invalid or exhibits signs of fraud. We recommend blocking the end user.

• ‘CHALLENGE` - This email has some potentially fraudulent attributes. We recommend increased friction such as 2FA or other forms of extended user verification before allowing the privileged action to proceed.

The type of this field is RiskResponseAction (string enum).

risk_score

A score from 0 to 100 indicating how risky the email is. 100 is the most risky. The type of this field is Integer.

status_code

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. The type of this field is Integer.

# File 'lib/stytch/fraud.rb', line 383

def risk(
  email_address:
)
  headers = {}
  request = {
    email_address: email_address
  }

  post_request('/v1/email/risk', request, headers)
end