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:

1. Setting up the Vouched plugin in the Workflow
2. Setting up the Socure Plugin in the Workflow
3. Setting up the Prove Identity Plugin in the Workflow
4. Setting up the Alloy Document Verification Plugin in the Workflow
5. Adding Step Up Workflow to a Journey

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.

1. 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.

2. Click the ⋮ menu then select SDK Configuration from the Workflow menu
   

3. Select Vouched from the Alloy SDK Plugin dropdown
   

4. Fill in your Vouched public key (required) to initialize the Vouched SDK on your behalf.

5. Fill in optional parameters

   • Types of Verification:
     1. ID with Selfie Verification
     2. ID Only
   • Selfie Submit Method
     1. Upload - file upload
     2. Camera - take photo with camera
     3. Both - User has the option to choose if they want to upload or use their camera
   • Selfie Liveness
     1. Mouth - checks for mouth movements
     2. Orientation - checks the facial orientation
     3. Distance - checks for user movements
     4. Straight - checks if the user is looking at the camera
   • ID Submit Method
     1. Upload - file upload
     2. Camera - take photo with camera
     3. 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.

1. 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.
2. Click the ⋮ to expand the more options menu, then select SDK Configuration from the menu.
   
   
3. Select Socure from the Alloy SDK Plugin dropdown.
   
   
4. Under the Function Arguments, fill in your Socure public key (required) to initialize the Socure SDK on your behalf. The public key is specific to your Socure account.
5. Under Process Configuration Arguments, fill in any of the additional fields:

•  sendMessage - controls the SMS send behavior of the Web SDK plugin. SMS is used for handoff from web to mobile. By default, this setting uses the Socure SMS delivery. If you prefer to use a different method, set the drop-down to false.
• 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- Spanish
  • fr- French
  • zh-cn- Simplified Chinese
   

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.

1. Create a workflow specifically for a Prove use case
2. Add Prove as a service with relevant attributes.

3. 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 prefill or identity
   • sms_provider - either prove, custom, or none (default)

   The following are only required if custom is selected as the sms_provider. When using the Prove Plugin with a custom sms_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
     
     The screenshot demonstrates the Options where the solution is identity, the sms_provider is custom, and Twilio is set up. Values set for the Twilio keys are placeholders.
4. Click the ⋮ to expand more options menu, then select SDK Configuration from the menu.
   
5. Select Prove from the dropdown.
6. Optionally fill in consent language and link to your Terms & Conditions page if you’d like it to appear on the plugin for the end user.
   

Setting up the Alloy Document Verification Plugin in the Workflow

1. Create a workflow specifically for a DocV use case (person or business depending on your use case).

2. Add relevant data vendors and attributes for your DocV workflow. If you do not have any data vendors for DocV available, you may need to engage Sales or your Customer Success Manager to add on additional data services.

3. Add the following input attributes with data type set to "string".

• document_token_front - if collecting a license, Canada Provincial ID, or Canada Indigenous card
• document_token_back - if collecting a license, Canada Provincial ID, or Canada Indigenous card
• document_token_selfie - if doing selfie
• document_step - if doing validation pre-checks

4. Define SDK inputs by selecting SDK Config from the Workflow Menu.

5. Select "Document Verification"

   • Require Selfie - Require a user to take a selfie to send with their documents
   • Force user to follow mobile flow - Users on a Desktop are forced to upload documents on a mobile device via QR code or SMS
   • Validation Pre checks - Each document step must pass a pre check for image quality before continuing to the next step
   • Select all eligible documents you would like the user to be able to upload.
     
     Note: Each set of documents a client wants to collect needs its own workflow. For example, if you want to collect (license or passport) and (paystub or w2), the first set of parentheses would be one workflow and the second set would be a second workflow

To learn more about the Alloy Plugin, read further on Document Verification: Alloy Plugin over Alloy SDK Overview

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.

1. Create a Journey with a Step Up node

2. 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

3. 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).