Third-Party Provider:
Please note that the instructions in this article pertain to a third-party provider and as such may not reflect all current settings. Should you have any questions or issues, please contact the third-party provider directly.
Onfido is an IDV (ID Verification) provider based out of London, UK. They provide ID Verification services using the most cutting-edge technology with AI for face detection, ID verification, etc. Onfido helps companies with various use cases like KYC (Know Your Customer), User Onboarding, User Verification, Fraud Detection, etc.
Get Onfido Account
In order to enable our Onfido integration, you'll need to create an account by reaching out to the Onfido team here. Already have a Onfido account? Please skip to the next section.
Set up Onfido Integration
Reach out to your CSM or [email protected] to enable this feature on your account. Once Onfido has been enabled for your account move to step 2.
Contact the Onfido team to request the relevant API Key and Account ID.
Copy it for use in Fountain.
Go to the Fountain page. Hover over your username on the top right, and click Integrations.
Click on Screening tab on the left side. Click Connect to the right of Onfido.
Enter your Onfido API Key and Account ID.
Click Save Changes, and you're done!
Important Warning:
Please ensure to put in the correct API key and AccountID, otherwise, the Integration might not connect properly with Onfido.
Set up Webhooks
Log in to your account in Onfido's website and select the Developers tab in the left menu.
Select Webhooks.
To create a webhook you will need to copy this URL:
https://ms-onfido-v2.herokuapp.com/onfidov2/resultsSelect Create Webhook.
Uncheck all of the check boxes located in the create webhook window; except the Completed box in the CHECK section.
Paste the URL we copied in step 3 into the URL field.
Select Save.
Important Note: Standard Requirement
Webhooks are required for all customers who plan to use Onfido in Fountain.
Add Onfido Stage to Workflow
Choose Onfido Partner Stage to add the stage to your Opening's workflow. Check out our article on how to add a stage here.
When an applicant lands in the Onfido Partner Stage in the application workflow, he will be going through a seamless Fountain-hosted iFrame flow for Onfido's IDV.
Once an applicant submits relevant info, they will automatically move to the next stage depending on the stage configuration.
Important Note:
Currently, Fountain shows all packages from in the partner stage. Please select the correct package to create a partner stage rule.
Onfido Partner Stage Rule
You can create partner stage rules on applicants in the Onfido stage in the workflow editor. There are six statuses you can take action on Incomplete, In Progress, Waiting, Clear, Consider, and Error. Explanation of the status and their values are:
Incomplete indicates an applicant hasn't started the IDV process yet for Onfido workflow
In Progress indicates an applicant is in the process of submitting all data to Onfido
Waiting indicates an applicant submitted all data to Onfido, awaiting final result from Onfido
Clear indicates an applicant passed the IDV screening from Onfido
Consider indicates an applicant failed the IDV screening from Onfido
Error indicates there is an error, canceled, etc. for Onfido status
This integration also supports Partner Detail functionality. Partner Details are detailed reasons why an applicant might fail the ID Verification process. Users can create rules in the Onfido partner stage or the Custom stage with rules depending on the use case to move the applicants through the funnel.
Important Note:
Partner Detail can have dynamic values. Please enter the exact values to make the rules in the Partner Stage or Custom Stage with rules depending on your use case.
An example of the Partner stage with rule in the Onfido partner stage:
An example rules setting in the Custom Stage with Rules:
Best Practice:
We recommend that you use Custom Stage with Rules if the status comes back asynchronously from Onfido. Since an ID Verification may take anywhere from one to 5 minutes to complete, the custom stage with rules can hold the applicant until the final result has come back.