Adding Device Profiling

Choose an integration

For a single-page application or an integration that routes profiling through your own domain, use the relevant implementation guide:

Connect the profile to an API event

Signifyd links a device profile to an order through a session ID. The device profile and the related API request must use the same value:

1. Obtain a unique session ID for the checkout. For the web script, generate it before profiling begins. For a Mobile SDK, use the session ID returned by the SDK.
2. Send the same value in device.sessionId in the related Checkout API or Sale API request.

%%{init: {"theme":"base","themeVariables":{"fontFamily":"Proxima Nova, Arial, sans-serif","actorBkg":"#003459","actorBorder":"#00A3E0","actorTextColor":"#FFFFFF","actorLineColor":"#9FADBF","signalColor":"#0070BD","signalTextColor":"#444546","noteBkgColor":"#E8EEF6","noteBorderColor":"#EAAA00","noteTextColor":"#003459","labelBoxBkgColor":"#E8EEF6","labelBoxBorderColor":"#A438A8","labelTextColor":"#003459","activationBkgColor":"#E31C79","activationBorderColor":"#582C83"},"sequence":{"width":190,"actorMargin":90,"diagramMarginX":100,"messageMargin":45,"wrap":true,"wrapPadding":15,"actorFontSize":14,"messageFontSize":14,"noteFontSize":14}}}%%

sequenceDiagram
    participant Client as Your website or app
    participant Backend as Your backend
    participant Signifyd

    Note over Client,Backend: Obtain a unique session ID
    Client->>Signifyd: Web script or Mobile SDK sends the device profile with the session ID
    Note over Client,Signifyd: Profiling runs in the background while the customer shops
    Client->>Backend: Customer places the order, including the session ID
    Backend->>Signifyd: Checkout or Sale API request with device.sessionId
    Signifyd->>Signifyd: Match the device profile to the order by session ID
    Signifyd-->>Backend: API response with the decision

Keep the session ID unchanged throughout one checkout, and use a new value for the next checkout. The implementation guide for your platform describes the exact format, code, and API fields.

Verify device profiling

After completing the client-side tests in the implementation guide for your platform, confirm in the Signifyd Console that Signifyd matched the profile to your test order:

1. Submit a test order through the Checkout API or Sale API using the same session ID as the web script.
2. In the Signifyd Console, open Developer Tools and select Data Quality.
3. Select Select Teams and choose the team that received the test order.
4. On the Standard search tab, set the Date range to include the test order, then search by order ID or case ID. If the order does not appear yet, select Refresh Results.
5. Confirm that Order Session ID matches the session ID used during profiling.
6. Confirm that Device Profiling Call Made By Signifyd is Yes.
7. Confirm that Device Data Present is Yes.

If Device Data Present is No, follow the troubleshooting steps in the Device Profiling guide.

Best practices

Before deploying to production, mimic your production checkout flow and create test orders that cover the ways customers buy from you:

• Test each order channel where profiling is expected to run, such as your website and mobile applications.
• Test representative payment methods and payment gateways, including cards, PayPal, Apple Pay, and gift cards where applicable.
• Follow the same page flow and timing as your production checkout.
• Use the implementation guide for your platform to confirm that profiling completed on the client.
• Use Data Quality to confirm that Signifyd matched the profile to the test order.