# Signifyd Documentation

> Documentation for Signifyd

## Guides: Overview
- [Getting Started](https://developer.signifyd.com/main/docs/getting-started.md): Integrating Signifyd on your online stores enables orders placed on your stores to be sent to Signifyd for Guaranteed Fraud Protection. This guide will cover the minimum components to build a…
  - [Authenticating](https://developer.signifyd.com/main/docs/authenticating.md): With Signifyd, API keys are linked to Teams. Teams are groups that help you manage user access and API permissions for orders submitted from your online store.
  - [Preparing Data](https://developer.signifyd.com/main/docs/preparing-data.md): To submit an order from your online store to Signifyd for fraud review, you will start by creating an order using the Checkout API (Pre-Auth) or Sale API (Post-Auth).
  - [Sending Orders](https://developer.signifyd.com/main/docs/sending-orders.md): After you have completed the mapping and transformation steps, you are ready to submit your first order to Signifyd.
  - [Verify Data Quality](https://developer.signifyd.com/main/docs/verify-data-quality.md): To ensure optimal fraud detection performance, Signifyd analyzes each order for data quality issues. If a data quality issue is detected, the details of the issue and steps to resolve are displayed…
  - [Adding Device Profiling](https://developer.signifyd.com/main/docs/adding-device-profiling.md): Signifyd device profiling collects device, browser, network, and navigation signals that help identify devices and assess fraud risk. For browser-based experiences, integrate the Signifyd web…
  - [Configuring Webhooks](https://developer.signifyd.com/main/docs/configuring-webhooks.md): Signifyd can send a webhook to notify your online store every time a guarantee decision is made on a submitted order. This provides you with real-time updates enabling you to ship orders quickly and…

## Guides: Chargebacks
- [Adyen](https://developer.signifyd.com/main/docs/adyen.md): Connect your Adyen account with Signifyd to sync chargebacks as soon as they are created.

## Guides: Returns
- [Overview](https://developer.signifyd.com/main/docs/returns-overview.md)
  - [Fraud vs Abuse in Returns](https://developer.signifyd.com/main/docs/fraud-vs-abuse-in-returns.md)
- [Cancelling Guarantees](https://developer.signifyd.com/main/docs/cancelling-guarantees.md)

## Guides: Accounts
- [Overview](https://developer.signifyd.com/main/docs/accounts-overview.md)
  - [Recommended Actions](https://developer.signifyd.com/main/docs/recommended-actions.md)
  - [Feedback API Overview](https://developer.signifyd.com/main/docs/feedback-api-overview.md)

## Guides: INTEGRATIONs
- Onboarding New Store
  - [Testing](https://developer.signifyd.com/main/docs/testing.md)
  - [Data Quality Validation](https://developer.signifyd.com/main/docs/data-quality.md)
  - [Calibration](https://developer.signifyd.com/main/docs/calibration.md): A required period of time prior to launching a site with Signifyd, used to train the Signifyd models.
- Shopify
  - [How it Works](https://developer.signifyd.com/main/docs/how-it-works.md)
  - Installation
    - [1) Add Signifyd App](https://developer.signifyd.com/main/docs/installation-copy-1.md)
    - [2) Add Shopify Web Pixels](https://developer.signifyd.com/main/docs/shopify-plugin-web-pixels.md): Signifyd customers using Shopify can deploy Signifyd's device profiling scripts on checkout and post-purchase pages via Web Pixels when the standard device profiling script process is insufficient or…
  - [Automation](https://developer.signifyd.com/main/docs/shopify-plugin-auto-fulfillment.md): Learn how to configure the Signifyd integration for Shopify to enable auto-fulfillment for eligible orders.
  - [Customizations](https://developer.signifyd.com/main/docs/shopify-plugin-customizations.md): Make adjustments to various Signifyd/Shopify features
- BigCommerce
  - [How it Works](https://developer.signifyd.com/main/docs/how-it-works-1.md)
  - Installation
    - [1) Add Signifyd App](https://developer.signifyd.com/main/docs/installation.md)
    - [2) Add Scripts](https://developer.signifyd.com/main/docs/add-the-scripts.md)
  - [Automation](https://developer.signifyd.com/main/docs/automation.md)
  - [Customizations](https://developer.signifyd.com/main/docs/customizations-copy.md): Make adjustments to various Signifyd/Bigcommerce features
- Magento 2
  - [How it Works](https://developer.signifyd.com/main/docs/how-it-works-2.md)
  - [Installation](https://developer.signifyd.com/main/docs/installation-1.md)
  - [Automation](https://developer.signifyd.com/main/docs/automation-1.md)
  - [Customizations](https://developer.signifyd.com/main/docs/customizations-1.md)
  - [Troubleshooting steps](https://developer.signifyd.com/main/docs/troubleshooting-steps-wip.md)

## Guides: Developer Tools
- [Device Profiling](https://developer.signifyd.com/main/docs/device-profiling.md): Device profiling helps Signifyd recognize devices and assess risk by collecting device, browser, network, and navigation signals throughout a customer journey.
  - [SDKs for Mobile](https://developer.signifyd.com/main/docs/sdks-for-mobile.md): Integrate to your mobile application using SDKs.
  - [SPA Device Profiling](https://developer.signifyd.com/main/docs/spa-device-profiling.md): A traditional website reloads the document during navigation, so the Signifyd device profiling script runs automatically on every page where it is installed. A single-page application changes views…
  - [First-Party Proxying](https://developer.signifyd.com/main/docs/first-party-proxying.md): Browser extensions, privacy-focused browsers and network security tools may restrict requests to third-party domains. First-party proxying routes Signifyd device profiling through a domain owned by…
- API
  - [Error handling](https://developer.signifyd.com/main/docs/error-handling.md)

## Guides: PARTNER
- [Session Intelligence](https://developer.signifyd.com/main/docs/session-intelligence.md): Session Intelligence lets your backend retrieve the latest device, browser and navigation intelligence Signifyd has profiled for a session. It can add device context to account activity, checkout…

## API Reference: Signifyd API
- [Fundamentals](https://developer.signifyd.com/main/reference/introduction.md): This document will show you how to use Signifyd's REST API to authenticate, make requests, and retrieve data.
- [Authentication](https://developer.signifyd.com/main/reference/authentication.md)
- [Required vs. Needed Fields](https://developer.signifyd.com/main/reference/required-vs-needed-fields.md): Programmatic vs. operational requirements
- [Sensitive Data Protection Layer](https://developer.signifyd.com/main/reference/sensitive-data-protection-layer.md): Preventing the receipt of unwanted sensitive data
- Session Intelligence
  - [Session Intelligence](https://developer.signifyd.com/main/reference/getsessionintelligence.md): Use this endpoint to retrieve the latest device, browser, and navigation intelligence Signifyd has profiled for a session through the Signifyd web script or mobile SDK.  The `sessionId` path…

## API Reference: COMMERCE
- Purchases
  - [Checkout](https://developer.signifyd.com/main/reference/checkout.md): The Checkout endpoint in Signifyd's API is used to record a Checkout Event in a Pre-Auth flow. This call should be made _before_ calling your Payment Gateway. After the Payment Gateway call, you…
  - [Transaction](https://developer.signifyd.com/main/reference/transaction.md): The Transaction endpoint is used in a PreAuthorization flow where the initial Checkout call to Signifyd occurs before calling your Payment Gateway for authorization. The `checkoutId` and `orderId`…
  - [Sale](https://developer.signifyd.com/main/reference/sale.md): The Sale endpoint in Signifyd's API is used to record a Sale Event, which represents the completion of a purchase flow and the associated payment authorization in a **PostAuth** workflow.   Use this…
  - [Get Decision](https://developer.signifyd.com/main/reference/getdecision.md): Retrieve the latest fraud decision for an order in the Signifyd system.
  - [Get Decisions](https://developer.signifyd.com/main/reference/getdecisions.md): Retrieve the list of decisions associated with an order in the Signifyd system.
- Purchase Management
  - [Reprice](https://developer.signifyd.com/main/reference/reprice.md): The Repricing endpoint allows merchants to update an order's price for changes not initiated by the buyer, such as substituting an out-of-stock product. Repricing does not alter the original decision…
  - [Reroute](https://developer.signifyd.com/main/reference/reroute.md): Call this endpoint anytime Delivery Address on an Order needs to be changed.  The change will be linked to the original Order with the `orderId` parameter in the body.  Orders can be updated a…
  - [Record Return](https://developer.signifyd.com/main/reference/recordreturn.md): Call this endpoint to record a return, exchanges, cancel a guarantee (within 30 days of order placement) and/or refund that does not need a decision from Signifyd.
  - [Fulfillments](https://developer.signifyd.com/main/reference/fulfillments.md): Use this endpoint to record a list of fulfillments associated with an `Order`. All fulfillments passed here will be appended to existing fulfillments. If a fulfillment already exists on the order…
- Returns & Appeasements
  - [Create PostSale Requested Action](https://developer.signifyd.com/main/reference/createpostsalerequestedaction.md): Use this to log the initiation of a return, refund, exchange, or appeasement request.   This call captures the buyer's intent, allows for Signifyd evaluation (when desired), and anchors all…
  - [Update PostSale Action](https://developer.signifyd.com/main/reference/updatepostsaleaction.md): Use this to report status changes or final actions taken on a post-sale action.   Common updates include:   - Refund issued   - Replacement sent   - Request canceled or declined   - Guarantee…
  - [Record PostSale Action](https://developer.signifyd.com/main/reference/recordpostsaleaction.md): Use this when the entire return, refund, or appeasement has already been completed and you’re sending the outcome retrospectively.  This is the right choice for:   - Batch ingestion of historical…
  - [Submit PostSale Action Feedback](https://developer.signifyd.com/main/reference/submitpostsaleactionfeedback.md): Use this to report the quality of a return once the item is received, inspected, or confirmed. This feedback trains Signifyd’s models and powers insights dashboards.  Use cases include:   -…
- Chargebacks
  - [Create Chargeback](https://developer.signifyd.com/main/reference/createchargeback.md): <p>To create a chargeback against an Order in the Signifyd system, you need to record a Chargeback Event.</p> <p>Within this call, Signifyd will create a single claim, along with the chargeback. Any…
  - [Representment Outcome](https://developer.signifyd.com/main/reference/representmentoutcome.md): <p>To set the outcome of a Chargeback's Representment in the Signifyd system, you need to record a Representment Outcome Event.</p>
  - [Chargeback Stage](https://developer.signifyd.com/main/reference/chargebackstage.md): <p>To change the stage of a Chargeback in the Signifyd system, you need to record a Chargeback Stage Event.</p> <p>As well as changing the Chargeback stage, this Api allows you to optionally also…
  - [Create Early Alert](https://developer.signifyd.com/main/reference/createearlyalert.md): <p>To create an early alert against an order in the Signifyd system, you need to record an Early Alert Event.</p>

## API Reference: LEGACY RETURNS
- Return
  - [Attempt Return](https://developer.signifyd.com/main/reference/attemptreturn.md): Use this endpoint to solicit an evaluation from Signifyd when the customer is requesting a refund, exchange, and/or a return. The response contains the checkpointAction, which will drive any merchant…
  - [Execute Return](https://developer.signifyd.com/main/reference/executereturn.md): Use this endpoint to inform Signifyd of subsequent actions on a return/refund/exchange request that was previously submitted for evaluation via the Attempt Return API. Integration of this endpoint is…
  - [Return Feedback](https://developer.signifyd.com/main/reference/returnfeedback.md): Use this endpoint to provide Signifyd with information regarding the quality of a return/refund/exchange (i.e. if it was later discovered to be an "abusive" return or a confirmed "good" return). If…

## API Reference: WEBHOOKS
- Webhook Management
  - [Create Webhook](https://developer.signifyd.com/main/reference/createteamwebhook.md): Create a new webhook. This will add to the list of any existing webhooks. <br> The webhook endpoint must use SSL with either TLSv1.2 or TLSv1.3 protocols. <br>Cipher Suites currently supported are:…
  - [Get Webhooks](https://developer.signifyd.com/main/reference/getteamwebhooks.md): Get the list of webhooks for a team.  If the user belongs to the team with the given `teamId` or has sufficient privileges to access the team webhooks, a list of webhooks for that team will be…
  - [Get Webhooks By Version](https://developer.signifyd.com/main/reference/getteamswebhooksbyversion.md): Get the list of webhooks for a team for a specific API version - V2, V3 or ALL.   The user can supply a list of team IDs and will receive a list of webhooks for each team they have access to. If the…
  - [Update Webhook](https://developer.signifyd.com/main/reference/updatewebhook.md): Replaces an existing webhook identified by the `hookId`.
  - [Delete Webhook](https://developer.signifyd.com/main/reference/deletewebhook.md): Deletes an existing webhook identified by the `hookId`.
  - [Test Webhook](https://developer.signifyd.com/main/reference/testwebhook.md): Tests that a webhook can be called and responds successfully.

## API Reference: ACCOUNTS
- Openings
  - [Account Opening](https://developer.signifyd.com/main/reference/accountopening.md): The Account Opening API is designed to detect and prevent fake accounts, bots, and synthetic identity abuse before an account is created.  It analyzes various attributes including behavioral, device,…
  - [Account Opening Feedback](https://developer.signifyd.com/main/reference/accountopeningfeedback.md): The Account Opening Feedback API allows merchants to send the final outcome of a signup attempt back to Signifyd. This feedback helps close the loop between our real-time recommendations and what…
- Modifications
  - [Account Modification](https://developer.signifyd.com/main/reference/accountmodification.md): The Account Modification API is designed to detect risky changes made to user accounts after login - especially in  sessions that may have been compromised. It analyzes behavioral, device, and…
  - [Account Modification Feedback](https://developer.signifyd.com/main/reference/accountmodificationfeedback.md): The Account Modification Feedback API captures the final outcome of sensitive account changes, such as password updates or contact info changes. By sending this feedback, merchants help Signifyd…
- Logins
  - [Account Login](https://developer.signifyd.com/main/reference/recordlogin.md): The Account Login API is designed to detect and prevent account takeover (ATO) attempts in real time by analyzing  device, session, and behavioral signals during the login process. It returns a…
  - [Account Login Feedback](https://developer.signifyd.com/main/reference/accountloginfeedback.md): The Account Login Feedback API allows merchants to report the final result of a login attempt. This feedback enables Signifyd to compare our real-time recommendations with actual outcomes, improving…

## API Reference: Partners
- Organizations
  - [Create Organization](https://developer.signifyd.com/main/reference/createorganization.md): Creates an `Organization`. This is an entity used to group related `Teams` together for billing purposes. For example, if you have merchants that are mapped to `Teams`, but are billed at a higher…
  - [Get Organization](https://developer.signifyd.com/main/reference/getorganization.md): Gets the details for an `Organization`
  - [Update Organization](https://developer.signifyd.com/main/reference/updateorganization.md): Updates an `Organization`. Any fields not supplied will not be changed.
  - [Get Organization Members](https://developer.signifyd.com/main/reference/getorganizationmembers.md): Gets a paginated list of details for all members at the `Organization` level.
  - [Add Organization Member](https://developer.signifyd.com/main/reference/addorganizationmember.md): Adds a user as an `Organization` level member. Such members will have access to all `Teams` belonging to that `Organization`. Members at `Organization` level can only be removed at `Organization`…
  - [Update Organization Member](https://developer.signifyd.com/main/reference/updateorganizatonmember.md): Updates a member at an `Organization` level. Any fields not specified will not be changed.
  - [Get Organization Member](https://developer.signifyd.com/main/reference/getorganizationmember.md): Gets the details for an `Organization` member.
  - [Remove Organization Member](https://developer.signifyd.com/main/reference/removeorganizationmember.md): Removes `Organization` membership from a user. This will remove the ability for that user to access information regarding all `Teams` belonging to the `Organization`.
- Partners
  - [Get Partner Members](https://developer.signifyd.com/main/reference/getpartnermembers.md): Gets a paginated list of details for all members at the `Partner` level.
  - [Add Partner Member](https://developer.signifyd.com/main/reference/addpartnermember.md): Adds a user as a `Partner` level member. Such members will have access to all `Teams` belonging to all `Organizations` belonging to the `Partner`. Members at `Partner` level can only be removed at…
  - [Update Partner Member](https://developer.signifyd.com/main/reference/updatepartnermember.md): Updates a member at a `Partner` level. Any fields not specified will not be changed.
  - [Get Partner Member](https://developer.signifyd.com/main/reference/getpartnermember.md): Gets the details for a `Partner` member.
  - [Remove Partner Member](https://developer.signifyd.com/main/reference/removepartnermember.md): Removes `Partner` membership from a user. This will remove the ability for that user to access information regarding all `Organizations` and `Teams` that the user is not directly a member of.
- Teams
  - [Create Team](https://developer.signifyd.com/main/reference/createteam.md): A fundamental unit of the Signifyd API is a `Team`. A single `Team` typically equates to a single merchant. Orders are submitted to Signifyd under that `Team` and users belonging to that `Team` can…
  - [Get Team](https://developer.signifyd.com/main/reference/getteam.md): Gets the details for a `Team`
  - [Update Team](https://developer.signifyd.com/main/reference/updateteam.md): Updates a `Team`. Any fields not supplied will not be changed. If one wishes to update the status or products of a `Team` one must use the endpoints specifically for that purpose rather than this…
  - [Set Team Live](https://developer.signifyd.com/main/reference/setteamlive.md): Change the team status from `BURN_IN` to `LIVE`. For teams created using the Partners API Teams, Signifyd will have to approve internally before this endpoint can work.
  - [Add Team Product](https://developer.signifyd.com/main/reference/addteamproduct.md): Adds a product to the Team
  - [Get Team Members](https://developer.signifyd.com/main/reference/getteammembers.md): Gets a paginated list of details for all members at the `Team` level.
  - [Add Team Member](https://developer.signifyd.com/main/reference/addteammember.md): Adds a user as a `Team` level member.
  - [Update Team Member](https://developer.signifyd.com/main/reference/updateteammember.md): Updates a member at a `Team` level. Any fields not specified will not be changed.
  - [Get Team Member](https://developer.signifyd.com/main/reference/getteammember.md): Gets the details for a `Team` member.
  - [Remove Team Member](https://developer.signifyd.com/main/reference/removeteammember.md): Removes `Team` membership from a user.
- Users
  - [Create User](https://developer.signifyd.com/main/reference/createuser.md): Creates a `User` with a given email address or finds an already created `User` by the `Partner`. Although the `Partner` owns this `User` and can make any changes they want to the `User`, the `User`…

## Recipes
- [Create your first order](https://developer.signifyd.com/main/recipes/create-your-first-order.md)