Skip to main content

​
Introduction

This guide explains how to configure the iDenfy Shopify App for your store.

​
App Setup

Requirements:
  • Live production environment (available via the Pricing page)
  • API key and secret — generated via the dashboard

​
Install the iDenfy App

Install the iDenfy app and approve the required permissions if prompted. shopify-app-installation

​
Configure iDenfy Admin

​
Provide the API Key and API Secret

Save the API Key and API Secret, then select the verification flow. app-configuration

​
Account page flow

  • Shows the verification button on the account page.
  • Hides the checkout button until verification is complete, preventing the user from making a purchase.
  • If the user is already verified, a verification status badge is shown on the account page.
flow-account-configuration

​
Before checkout flow

  • Shows the verification button on the cart drawer/page. Hides the checkout button until verification is complete.
  • The SDK is initialized when the user clicks the verification button, displaying the iDenfy verification dialog.
  • On successful verification, the checkout button is enabled.
flow-cart-drawer flow-cart-idenfy-dialog

​
After checkout flow

  • Shows the verification button on the Thank You/Order status page.
  • The customer is redirected to the verification page.
  • The verification message is updated when the user refreshes the page or visits another page.
flow-after-checkout-sdk

​
Enable the iDenfy App for your theme

Go to Online Store in Shopify Admin, then Themes > Customize.
Ensure the correct “Verification flow” is selected in the iDenfy Shopify Admin.

​
App embed blocks — “Account (Legacy)” and “Before checkout” flows

These flows use App embed blocks to embed the iDenfy SDK. Make sure the block is enabled for the theme. Block settings:
  • Custom CTA text
  • Custom checkout button selector (for custom themes)
  • Custom Account (Legacy) button selector (for custom themes)
Styling (Advanced): CSS variables are used to style the block, allowing developers to customize it to match the theme: 
:root {
  --idenfy-modal-desktop-width: 60vw;
  --idenfy-modal-desktop-height: 90vh;
  --idenfy-modal-mobile-width: 100vw;
  --idenfy-modal-mobile-height: 90vh;
  --idenfy-modal-backdrop: rgba(0, 0, 0, 0.5);

  --idenfy-btn-min-width: 160px;
  --idenfy-btn-font-size: 16px;
  --idenfy-btn-line-height: 1.5;
  --idenfy-btn-padding: 10px 24px;
  --idenfy-btn-border-radius: 5px;
  --idenfy-btn-bg-color: #28a745;
  --idenfy-btn-text-color: white;
  --idenfy-btn-bg-color-hover: #218838;
  --idenfy-btn-text-color-hover: white;
  --idenfy-error-text-color: #c70a24;

  --idenfy-message-font-size: 14px;
  --idenfy-message-padding: 4px 16px;
  --idenfy-message-margin: 16px 0;
  --idenfy-message-border-radius: 5px;
  --idenfy-message-success-bg-color: #28a745;
  --idenfy-message-info-bg-color: #ffb800;
  --idenfy-message-info-text: black;
  --idenfy-message-success-text: white;
}
config-embed-theme-app

​
Checkout/Account extensions — “Account” and “After checkout” flows

These flows use Checkout/Account UI extensions to embed the iDenfy SDK.
Styling is limited in this flow due to the limitations of Checkout/Account UI extensions.
Setup: Select Checkout and customer accounts from the dropdown. extensions-checkout-dropdown Add the iDenfy extension to the Thank you, Profile, and Order status pages. extensions-checkout-apps Click on the extension to select where it should be displayed. extensions-checkout-apps-position

​
Configure the iDenfy Webhook

On the iDenfy Dashboard, go to the Webhooks section. idenfy-webhook-setup
  • Add an ID verification webhook.
  • Receiver: https://oma-idenfy-app.fly.dev/api/sdk/verification/webhook
  • Signing key: API key provided by iDenfy (same as in the Shopify App Admin).
The API key is used to verify the webhook request. Without the correct API key, the webhook will not be processed.

​
Customer details

  • If email/phone is available during the verification process, it will be saved in the customer details.
  • The metafield Idenfy: Identity verified controls the verification status:
    • true — Customer is verified.
    • false — Customer is not verified.
  • Idenfy: ID scan reference stores the iDenfy verification reference.
  • An idv-{status} tag is added to the customer based on the iDenfy verification status (e.g. idv-approved, idv-denied, idv-suspected).
customer-acc-verified

​
Order details

  • If the customer is logged in during verification (e.g. “Before checkout” and “After Checkout”), the verification status is shown in the order Notes.
  • The same status is saved on the Customer details.
order-details-approved
  • If the customer is not logged in during verification (e.g. “Before Checkout” flow), the verification status is shown in the order Notes.
    • Customer status is not updated in this case since customer details are not available at the time of verification.