Onfido Salesforce Integration
This guide is to help you install and configure the Onfido Salesforce integration, and provide reference implementations for common automations using workflows, Process Builder, etc.
Throughout the installation, you will be instructed to navigate through Setup. To do so, select the gear to the upper right and then Setup. Once in Setup, you can use the Quick Find box to find and navigate to the appropriate section:
Installing the Onfido Package
Open a new window and navigate to the following URL:
Install for Admins Only is recommended. This option allows for controlling access and permissions after the package has been installed. For further information, you can refer to to refer to Salesforce documentation on Package Installations.
For Approve Third-Party Access, check the boxes as shown in the following image:
Select Continue to start the package installation when the modal appears.
Configuring the Salesforce Org
This section shows how to configure the package's Permission Sets and assign them to Salesforce Users.
The Onfido API User Permission Set is used behind the scenes to initiate verifications and integrate the results.
Navigate to the Quick Find, then search for “Permission Sets”:
Select Clone next to the Onfido API User Permission Set:
Enter in a new value for Label and select the API Name field which will automatically populate, then select Save.
Select the Onfido API User Clone Permission Set that was just created:
Select Object Settings:
You will need to select the following: Accounts, Cases, Contacts, and Opportunities to give Read Access to in Object Permissions.
If you have Person Accounts enabled, add permissions to the Person Account Record Type for the Account object as well.
Check Object Permissions - Read, and select Save:
Navigate to System Permissions:
Check API Enabled, then select Save.
The Onfido Feature Set Access Permission Set is used to provide your users access to Onfido identity verifications.
Repeat the steps shown above to clone the Onfido Feature Set Access Permission Set.
Select the Onfido Feature Set Access Permission Set that was just cloned:
Navigate to Object Settings.
You will need to select all of the following objects:
Add Read Object Permissions.
For the object you are running verifications from, you will need to also do the following:
- Person Account: make sure Record Type is checked if running verifications from Person Accounts
- Object Permissions - Read/Create/Edit/Delete
- Field Permissions - Read/Edit on your fields used in the field mappings, which will also become required fields for your users to initiate verifications
Select Manage Assignments:
Select Add Assignments:
Select the Users who need access to the Onfido identity verification features, then select Assign:
Configure the Onfido Salesforce App
Now that you've installed and configured the Onfido package, it's time to configure it.
Navigate to App Launcher then Onfido Setup:
If you do not see the Onfido Setup app, either type “Onfido” to search for it or select the View All link at the bottom to see the full list of apps:
API Key and Webhook URL
Select Get Started.
If you have an existing Onfido Account, then select your region and enter your API Key, then select Verify then Next.
Otherwise, complete the form to request a new account and return here when it is set up:
Now you will have to enter the URL of the Salesforce site that will be used to accept status updates and other data coming from Onfido.
Follow the instructions on this page to configure your site:
After your site has been configured, copy-paste the URL into the field and select Next.
The next step involves selecting the site on which the Onfido verification form will be hosted. Your applicants will be sent here when completing their verification process.
Follow the on-screen instructions. If using the same site from the previous step, the URL field is pre-filled for you.
Default Report Settings
Next, you'll selecting the reports that available to your users when they initiate a verification for an applicant.
Check the Active boxes for the reports that you want to be available for your users.
Check the Default boxes for the reports that should be selected by default when a user initiates a verification for an applicant. Only one default can be selected per report type.
Once finished, select Next.
Data Field Settings
In this section you will determine how externally created applicants will be represented in your Salesforce org. As well as the required fields that must be entered on a Salesforce record in order to run a verification. This will also be your object when running Onfido verifications and if at any time you wish to select a different object you will need to change your object and field mappings back in this section of the Onfido Setup app. You will map the Onfido object to a Salesforce object of your choice, and then map the Onfido fields to Salesforce fields. These will need to be custom fields if you are selecting Account, Case, or Opportunity.
You will not need to create custom Salesforce fields if your object selection is Contact or Person Account.
Your custom fields (Data Type) should be Email or Text.
Select Next once you are finished with selecting the object and mapping its fields to complete the Onfido app setup.
Adding the Verify Identity Component to a Record Page
This component will allow your users to initiate Onfido verifications based on the object selected in the Data Field Settings step above and send the verification email to an applicant.
The Onfido Identity Verification component needs to be added to the record page where you want it to be used.
While on a record page, select the Setup gear and select Edit Page.
Drag and drop the Onfido Identity Verification component from the Custom - Managed section onto the main panel:
Save the edited lightning page.
If this is the first time the record page is being activated, you will need to activate it. To change the settings at any time, you can select the blue Activation button while editing the lightning record page.
On the next few screens, assign this Record Page as the App Default for the Onfido App.
Select Assign as App Default after selecting the App Default tab.
Select the Onfido App, then select Next until Save is available, and select Save.
You've completed the installation and configuration of the Onfido Salesforce integration. You can now initiate verifications by selecting the button you added to the record page, or automate Onfido using Process Builder, Workflows, etc.
- Fix for breaking Winter of '21 release.
- Improvements to SDK. Title and subtitle are more generic and no longer ask to "open a bank account".
- SDK flow is conditional based on the report selected. Users don't have to go through both document and live photo/video upload if their report doesn't require it.
- SDK will prompt users with "no data is needed at this time" if the selected report(s) don't require the SDK.
- Contacts created with valid birthdate and mailing address will pass data to corresponding Onfido Applicant.
- Watchlist and identity reports will provide more meaningful results.
- SDK upgraded to version 6.6.
- Upon applicant creation, Onfido API error messages get passed back to Salesforce for easier troubleshooting.