How to configure and run a plugin for the Alloy SDK. This article will walk you through setup for the following, to get up and running with Step Up:
For instructions on how to integrate the SDK, please see our API docs.
Setting up the Vouched Plugin in the Workflow
Note: Setting up the Vouched Plugin requires the Vouched data service to be enabled for your account. If you do not have access to add the Vouched data service, please reach out to our Sales team or your Customer Success Manager to add it.
Create a workflow specifically for a document verification use case (person or business depending on your use case). Make sure Vouched is added as a service with relevant attributes.
Click the ⋮ menu then select SDK Configuration from the Workflow menu
Select Vouched from the Alloy SDK Plugin dropdown
Fill in your Vouched public key (required) to initialize the Vouched SDK on your behalf.
Fill in optional parameters
Types of Verification:
ID with Selfie Verification
ID Only
Selfie Submit Method
Upload - file upload
Camera - take photo with camera
Both - User has the option to choose if they want to upload or use their camera
Selfie Liveness
Mouth - checks for mouth movements
Orientation - checks the facial orientation
Distance - checks for user movements
Straight - checks if the user is looking at the camera
ID Submit Method
Upload - file upload
Camera - take photo with camera
Both - User has the option to choose if they want to upload or use their camera
ID Liveness - checks for user movements with ID Card
Include barcode to enable capture and processing for applicable IDs - Enable ID barcode capture and processing for applicable IDs.
Max number of retries before showing "Next" - Number of times to force users to retry before showing the Next button (Default: 0 - show Next button immediately).
Max number of retries in force retry cases - Number of times to force users to retry before showing the Next button in force-retry cases (the card doesn't meet the minimum threshold). The default is 2.
Setting up the Socure Plugin in the Workflow
Note: Setting up the Socure Plugin for Document Verification requires the Socure DV data service to be enabled for your account. If you do not have access to add the Socure DV data service, please reach out to our Sales team or your Customer Success Manager to add it.
Create a workflow specifically for a document verification use case (person or business depending on your use case). Make sure Socure DV is added as a service with relevant attributes.
Click the ⋮ to expand the more options menu, then select SDK Configuration from the menu.
Select Socure from the Alloy SDK Plugin dropdown.
Fill in your Socure public key (required) to initialize the Socure SDK on your behalf. The public key is specific to your Socure account.
Fill in any of the additional optional fields:
Automatically use Socure SMS delivery when phone number provided - controls the SMS send behavior of the Web SDK plugin. SMS is used for handoff from web to mobile.
Flow - controls the workflow of the document capture and upload process. Only available if customers integrate with Socure directly.
Language - determines the language of the text in the UI. All text in the Web SDK widget and the capture application will use the language set here. Available languages:
en- English (default)es- Spanishfr- Frenchzh-cn- Simplified Chinese
Record consumer Privacy Statement and Consent agreement decline - checkbox enables Alloy to capture when a consumer declines Socure’s privacy/biometric consent prompt. Alloy records the decline as a custom attribute on the Journey Application.
Setting up the Socure V5 Plugin
The Alloy Web SDK includes a plugin for Socure’s Predictive Document Verification V5, letting you render Socure’s document capture and verification flow in your onboarding experience without integrating Socure’s SDK yourself. The current plugin runs Socure DocV v5, which adds, on top of the v4 experience:
Setting up the Socure plugin for Document Verification requires the Socure DV data service to be enabled for your account. If you do not have access to add the Socure DV data service, please reach out to our Support team or your Customer Success Manager to add it.
Setting up the Socure v5 plugin in the workflow
Create a workflow specifically for a document verification use case (person or business depending on your use case). Make sure Socure DV is added as a service with relevant attributes.
Click the ⋮ to expand the more options menu, then select SDK Configuration from the menu.
Select Socure v5 from the Alloy SDK Plugin dropdown.
Fill in your Socure public key (required) to initialize the Socure SDK on your behalf.
Fill in the additional configuration fields:
Capture use case flow — The Capture App Flow is the customizable UI workflow of the document capture process. If a value is not provided, Socure DocV will leverage the default use case flow configured in your account.
Language — determines the language of the text in the Socure UI. The drop-down lists the 2-digit language code.
Document types — license, passport
Select one document type to send every applicant through that document’s capture flow.
Select multiple document types to have the applicant provide each of them within a single verification transaction.
Select none to fall back to the document type configured in your Socure settings.
Automatically use Socure SMS delivery when phone number provided — When the SDK runs, Socure will send a text message with the SDK link to the provided phone number.
Record consumer Privacy Statement and Consent agreement decline — This value will be recorded as a custom attribute on the consumer's Journey Application.
Save the configuration, then save the workflow and set it active.
Add the workflow to your Journey as a Step Up node.
Setting up the Prove Identity Plugin in the Workflow
Note: Setting up the Prove Identity Plugin requires the Prove data service to be enabled for your account. If you do not have access to add the Prove data service, please reach out to our Sales team or your Customer Success Manager to add it.
Create a workflow specifically for a Prove use case
Add Prove as a service with relevant attributes.
Define the Prove service Options. Click on Prove data service node and then the Options tab. Add the following as key / value pairs
solution - Either
prefilloridentitysms_provider - either
prove,custom, ornone(default)
The following are only required if
customis selected as the sms_provider. When using the Prove Plugin with acustomsms_provider, reach out to Alloy support or your CSM for the Twilio credentials.twilio_account_sid - Twilio account SID
twilio_auth_token - Twilio auth token
twilio_phone_number - Twilio phone number or short code configured to be sender for SMS messages
Click the ⋮ to expand more options menu, then select SDK Configuration from the menu.
Select Prove from the dropdown.
Optionally fill in language for Consent, Link to Terms, Approved Title, Approved Text, Confirmation Text, and Confirmation Link.
Setting up the SumSub Plugin
The Alloy Web SDK includes a plugin for SumSub identity and document verification, so you can render SumSub’s verification flow inside your onboarding experience without integrating SumSub’s SDK yourself. Like all Alloy SDK plugins, the code setup is the same as any other plugin — all SumSub-specific setup happens in the Alloy Dashboard.
The plugin runs on SumSub WebSDK 2.0.
Setting up the SumSub plugin
Create a workflow for your SumSub document verification use case and make sure SumSub is added as a service with the relevant attributes.
Click the ⋮ menu on the workflow, then select SDK Configuration.
Select SumSub from the Alloy SDK Plugin dropdown.
Enter the SumSub level name for the verification level the plugin should run. The level name must exactly match a level configured in your SumSub account.
Save the configuration, then save the workflow and set it active.
Add the workflow to your Journey as a Step Up node.
The end-user’s language can be controlled through the SDK’s language initialization parameter, which is passed through to SumSub.
How verification levels are used
SumSub organizes verification requirements into named levels. When the plugin launches, Alloy creates (or updates) the SumSub applicant against the level name in your SDK configuration, and SumSub’s review results are returned to your workflow for decisioning. Keeping level names consistent between your SumSub account and your Alloy configuration is what ties the two together — if you rename a level in SumSub, update your Alloy SDK configuration to match.
Setting up the Alloy Single Document Verification Plugin in the Workflow
The Alloy Single Document Verification Plugin is Alloy’s hosted document-verification experience within the Alloy SDK. It allows applicants to upload identity, income, or tax documents directly from an onboarding or Step Up flow. Alloy’s SDK provides the applicant-facing experience, while the workflow determines which documents can be uploaded and how the submitted information is evaluated.
Supported document types
The plugin supports the following document options:
1065
1099
1120
Bank Statement
Document
Canada Provincial ID
Canada Indigenous Card
License
Passport
Paystub
T1 (Canadian tax doc)
T4 (Canadian tax doc)
W-2
You can select all eligible document types that applicants should be allowed to upload to the workflow.
Note that the Single Document Verification is a legacy plugin, and the recommendation is to use the Multi-Document Collection Plugin.
To learn more about the Alloy Plugin, read further on Document Verification: Alloy Plugin over Alloy SDK Overview
Setting up the Alloy Multi-Document Collection Plugin in the Workflow
The Multi-Document Collection plugin is an Alloy-hosted Web SDK plugin that lets you request one or more documents from an applicant in a single step-up, with conditional logic that determines which documents each applicant is asked for. It replaces the legacy Alloy document collection plugin for document-collection use cases.
Use Multi-Document Collection when you need documents for manual review or storage in Alloy — for example, conditional credit-underwriting documents (paystubs vs. tax returns depending on income type) or enhanced due diligence documents such as proof of source of funds. It is not an identity document verification product: if you need automated verification of IDs, selfies, or liveness, use one of the identity verification plugins (for example Vouched, Onfido, Persona, or Socure) instead. Documents collected through this plugin also cannot currently be passed to a data service for automated processing.
Prerequisites
Your account must use Journeys. The plugin is not compatible with legacy Evaluations-only SDK implementations.
An SDK key must be created for your account; the SDK will not render without it.
Configuring the plugin
Open the step-up workflow and click the ⋮ menu, then select SDK Configuration.
Select Alloy Multi-Document Collection from the plugin dropdown.
Configure the request logic for each document:
Select Always if the document should be requested from every applicant who reaches the step-up.
Select Conditional if the document should only be requested when a specific Outcome Reason is present on the application.
Select a default document name, or enter a custom document name. The name you choose is displayed as the header of the upload page.
Select the required documents. The options include Paystub, W2, Tax Return, 1099.
Select the file type per category shown. If the right type is not listed, use Document.
Select the number of files the applicant must upload for this document (maximum 6).
Check off the setting Reset the document upload form upon retry if your Journey relies on retry nodes and you want to clear the Entity's uploaded documents.
Configure the content:
Default text exists for all content fields, so this step is optional — but we recommend customizing it so applicants have enough context to provide the right documents.
Configure the landing page content.
Configure the upload page for each document. You can add custom help text that displays under the document name to describe exactly what the applicant should provide.
Submit, then save the workflow and set the version active for the changes to apply.
Optionally customize the SDK outcome screens in your SDK settings. If outcome screens are disabled, the SDK closes automatically when the applicant finishes instead of showing an outcome screen.
Adding the step-up to a Journey
In your Journey, add the logic workflow (or make sure an existing workflow produces the Outcome Reasons that drive your document requests).
Add a Step Up node that points to the step-up workflow carrying the Multi-Document Collection configuration. Journeys cannot start with a Step Up node.
Things to note
There are no hard restrictions, but we recommend applicants upload images or PDFs and keep file sizes reasonable.
Alloy does not validate the quality of the document or that it matches the requested document type.
Documents collected through this plugin cannot currently be sent to a data service (for example, automated document-fraud vendors). If your policy requires automated document processing by a partner, use a third-party partner’s plugin directly.
Adding Step Up Workflow to a Journey
Journeys must be enabled in your account to create a Journey. If you do not see Journeys in the left-hand navigation, please reach out to your Customer Success Manager or contact Alloy Support to help enable it.
Create a Journey with a Step Up node
Journeys can not start with a Step Up node. Add your KYC workflow node first, then add a Step Up node to link it to the appropriate workflow
Set up a Journeys webhook by navigating to Settings > Webhooks > New Webhook. Create a Webhook using the "Notify on live journey application status change" action.
Note for Alloy’s Document Verification plugin: If you are collecting multiple sets of docs, each set needs its own DocV node (using the example from earlier there would be one node for license and passport and one node for paystub and w2).