Fraud

Unique identifier for a checkout.

Unique identifier for an Order.

A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services.

An MCC is used to classify every business that accepts card payments by the goods or services it provides. The MCC is provided by payment processors on authorizations.

Enum: "DECLINE_POLICY" "DECLINE_FRAUD" "APPROVE" "REVIEW"

If you have a legacy risk system independent of Signifyd, use this field to pass us the decision from that system.

This is most commonly used when onboarding.

Items Enum: "FRAUD" "INR" "SNAD" "ALL" "NONE"

The types of coverages requested. If no coverage object is provided or is empty, coverage will be set to the team's default policy.

For further information please contact your Signifyd Implementation manager.

• • FRAUD- use when you need a financial guarantee for Payment Fraud.
• • INR- use when you need a financial guarantee for Item Not Received.
• • SNAD- use when you need a financial guarantee for fraud alleging items are Significantly Not As Described.
• • ALL- use when you need a financial guarantee on all chargebacks.
• • NONE- use when you do not need a financial guarantee. Suggested actions in decision.checkpointAction are recommendations.

A list of attributes or short descriptors associated with the order.

Data about the device that was used by the user to complete the actions.

The IP Address of the device or browser. You must provide a valid IP address syntax.

Local host IPs or IPs from a CDN or load balancer should not be provided.

The unique id for the user's session. This is to be used in conjunction with the Signifyd fingerprinting javascript.

The unique id for the user's session. This is to be used in conjunction with the Signifyd fingerprinting javascript.

A device fingerprinting payload you supply to Signifyd for use in decisioning.

Some integrations with Signifyd perform device profiling before this API call and provide the profiling payload here. Standard Signifyd integrations do not need to provide this field. For more information on device fingerprinting, please see this link.

Details about the merchant's commerce platform.

The name of the merchant's commerce platform.

The version of the merchant's commerce platform.

Formatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601.

The channel or source where the order was placed.

'WEB', 'PHONE', 'MOBILE_APP', 'SOCIAL', 'MARKETPLACE', 'IN_STORE_KIOSK', 'SCAN_AND_GO', 'SMART_TV'

The total amount of the order, including the shipping price, taxes, and any fees. This should be the amount you want Signifyd to provide Guarantee Fraud Protection coverage for.

The currency in which the totalPrice and all other amounts are denominated. If omitted, the currency is assumed to be USD.

When this purchase was completed, you likely sent a confirmation email or you will be sending a confirmation email to the buyer once you approve the order.

This is the email address to which that confirmation email will be sent. You must provide a valid email syntax.

The phone number at which the buyer would be contacted if there was something wrong with this order or the phone number that was supplied with the shipping information.

The total amount the customer is paying for shipping the products.

If the order was placed on-behalf of a customer service or sales agent, his or her name.

Array of AbsoluteDiscountCode (object) or PercentDiscountCode (object).

A list of discount codes, coupons, or promotional codes used during checkout to receive a discount on the order. You can only provide the discount code and the discount amount OR the discount percentage.

A list of products purchased on the order and going to the given destination.

Details about the delivery destinations and the products for each one.

Data about the user's account with you, the merchant or service provider.

The username associated with the account. Please supply this even if it is the same as the email.

Formatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601.

Your unique identifier for the account.

>= 1

The total count of orders placed by this account since it was created, including the current order.

>= 0

The total amount spent by this account since it was created, including the current order.

The primary email address associated with the account.

The primary phone number associated with the account.

The unique identifier for the last order placed by this account, prior to the current order.

Formatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601.

Formatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601.

Formatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601.

Formatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601.

The membership object should be used to indicate the usage of a rewards, discount, or admission program by the buyer when they completed the checkout.

In some cases that membership may be a paid one, for example, if a buyer used a Costco membership to complete a purchase at Costco.

Other times that membership will be a be a free loyalty program, for example, if a buyer used a Frequent Flyer number when purchasing a plane ticket, it would also go here.

This object is conceptually distinct from userAccount whose attributes relate to the online account that was used by the buyer to complete the purchase; it's what the buyer "logs in to". You would never login to a "membership".

Name of the membership.

The phone number associated with this membership.

Email address associated with this membership.

Unique identifier for this membership in the merchant's system.

Use only if you operate a marketplace (e.g. eBay) and allow other merchants to list and sell products on the online store.

A seller is an online account for the merchant or business that listed and sold the product(s) on the order.

The business name of the seller.

The unique username associated with the seller.

This will likely be whatever they use to login to your site. Please supply this even if it is the same as the email address.

The unique ID of the seller generated by the parent entity.

The phone number associated with the seller.

The primary email address currently associated with the seller.

The domain of the seller.

Formatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601.

Formatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601.

The email address associated with this seller account when it was created.

The IP address of the device used when this seller account was created.

The unique ID of the parent entity associated with the seller.

The total count of orders sold by this seller since it was created, including the current order. >= 1

The total amount sold by this seller since it was created, including the current order. >= 0

A list of attributes or short descriptors associated with the seller account.

The address registered on the Seller account at which they say they should be contacted.

The user's account ID according to your systems. Note that user IDs are case sensitive.

Find valid user_id values here.

The user's current session ID, used to tie a user's action before and after login or account creation

Required if no user_id values is provided.

The ID for tracking this order in your system.

Email of the user creating this order.

Note: If the user's email is also their account ID in your system, set both the user_id and user_email fields to their email address.

Total transaction amount in micros in the base unit of the currency_code.

1 cent = 10,000 micros. $1.23 USD = 123 cents = 1,230,000 micros.

For currencies without cents of fractional denominations, like the Japanese Yen, use 1 JPY = 1000000 micros.

ISO-4217 currency code for the amount. If your site uses alternative currencies, specify them here.

For marketplace businesses, this is the seller's user ID, typically a database primary key.

Follow Sift's guidelines for user_id values.

Whether the user requested priority/expedited shipping on their order.

Indicates the method of delivery to the user.

ALLOWED VALUES "electronic", "physical"

Shipping carrier for the shipment of the product.

Name of the brand of product or service being purchased.

Domain being interfaced with. Use fully qualified domain name.

Country the company is providing service from. Use ISO-3166 country code.

Capture the type(s) of the account: "merchant" or "shopper" ,"regular" or "premium" , etc

The array supports multiple types for a single account, e.g. ["merchant", "premium"]

The billing address associated with this user.

Provide the full name associated with the address here.

Concatenate first name and last name together if you collect them separately in your system.

The phone number associated with this address. Provide the phone number as a string starting with the country code.

Use E.164 format or send in the standard national format of number's origin. For example: "+14155556041" or "1-415-555-6041" for a U.S. number.

Address first line, e.g., "2100 Main Street".

Address second line, e.g., "Apt 3B".

The city or town name.

The region portion of the address. In the USA, this corresponds to the state.

The ISO-3166 country code for the address.

The postal code associated with the address, e.g., "90210".

Send +4 postal codes with a '-', e.g., "90210-3344".

The details about the specific physical location providing the good or service.

This can also be used to capture pickup, delivery locations, etc.

The customer's internal identifier for the specific physical location providing the good or service.

Address field type represents a physical address, such as a billing or shipping address for eCommerce or sent and received address for remittance.

Shipping tracking number(s) for the shipment of the product(s).

The Promotion field type generically models different kinds of promotions such as referrals, coupons, free trials, etc.

The value must be a nested JSON object which you populate with the appropriate information to describe the promotion.

Not all sub-fields will likely apply to a given promotion. Populate only those that apply.

The ID within your system that you use to represent this promotion.

This ID is ideally unique to the promotion across users (e.g. "BackToSchool2016").

The status of the addition of promotion to an account. Best used with the add_promotion event.

This way you can pass to Sift both successful and failed attempts when using a promotion.

May be useful in spotting potential abuse. ALLOWED VALUES success,failure

Freeform text to describe the promotion.

The browser field type contains information about the browser.

The user agent of the browser that is interacting with your website.

The language(s) that the client is requesting the site content be delivered in.

Use ISO-3166 format for country codes. Examples: "en", "en-us, de", "fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5", etc.

The app field type represents the details of an application as well as the device and OS it's running on.

The operating system on which application is running. (e.g. iOS, Android)

The operating system version on which application is running. (e.g. 10.3.1, 7.1.1)

The manufacturer of the device on which application is running. (e.g. Samsung, Apple, LG)

The unique ID of the device on which application is running.

For iOS, send the IFV identifier. For Android, send the Android ID.

The model of the device on which application is running. (e.g. SM-G920x, iPhone8,1)

The name of your application.

The language the application content is being delivered in.

Use ISO-3166 format for country codes. Examples: "en", "en-us, de", "fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5", etc.