Identity Verification (Yoti): Difference between revisions

Jump to navigation Jump to search

Identity Verification (Yoti) (view source)

Revision as of 03:50, 5 December 2022

3,339 bytes added ,  03:50, 5 December 2022
no edit summary
No edit summary
No edit summary
Line 142: Line 142:
|}
|}


== The Integration ==
== The Integration Mechanism ==
[[File:Yoti Technical Workflow.png|thumb|Yoti technical workflow]]
[[File:Yoti Technical Workflow.png|thumb|Yoti technical workflow]]
This section describes the interactions for a web, mobile web and native mobile integration. Data Exchanges will occur securely between the 3B back end, Yoti and the client (the end user’s browser or mobile device).
This section describes the interactions for a web, mobile web and native mobile integration. Data Exchanges will occur securely between the 3B back end, Yoti and the client (the end user’s browser or mobile device).
Line 150: Line 150:
Every time a user elects to supply an ID document through the 3B integration, we will need to create a session with Yoti to perform the ID checks.
Every time a user elects to supply an ID document through the 3B integration, we will need to create a session with Yoti to perform the ID checks.


Once the Yoti Client has launched, it will take the end user through the ID document capture flow, followed by a liveness check. Once this flow is completed the end user is redirected back to the candidate portal, so that they may continue their onboarding journey.
Once the Yoti Client has launched, it will take the end user through the ID document capture flow, followed by a liveness check and any other check you have requested in the integration metadata.  
 


When using 3B's integration with Yoti from a [[Document Packs|Document Pack]], we can simply request an ID check as one of the steps of the onboarding process. Depending on how the integration is configured, here's a step-by-step guide of the candidate's worflow:
When using 3B's integration with Yoti from a [[Document Packs|Document Pack]], we can simply request an ID check as one of the steps of the onboarding process. Depending on how the integration is configured, here's a step-by-step guide of the candidate's worflow:


Step 1 - Candidate lands in the candidate portal or [[Document Packs|My Documents]] page for documents submission
Step 1 - Candidate lands in the candidate portal or [[Document Packs|My Documents]] page for documents submission


Step 2 - One of the items requested as part of the Document Pack is an Identity Check.  
Step 2 - One of the items requested as part of the [[Document Packs|Document Pack]] is an Identity Check.  


Step 3 - Candidate clicks on the entry and the Yoti identity verification workflow is launched. A candidate must take a photo of their ID document and perform a liveliness check.
Step 3 - Candidate clicks on the entry and the Yoti identity verification workflow is launched. A candidate must take a photo of their ID document and perform a liveliness check.


Step 4 - Identity verification workflow is completed, results are positive/negative. If results are negative, the candidate can re-submit and re-start the workflow. Automated email alerts drive this process
Step 4 - Identity verification workflow is completed, results are positive/negative. If results are negative, the candidate can re-submit and re-start the workflow. Automated email alerts drive this process.


If the identity verification was successful, a new Certificate will be created on the system with the OCR'd results from the ID Document provided. This certificate can then feed into the [[Compliance Engine]] in order to evaluate the candidate's compliance status.
If the identity verification was successful, a new Certificate will be created on the system with the OCR'd results from the ID Document provided. This certificate can then feed into the [[Compliance Engine]] in order to evaluate the candidate's compliance status.
== Configuration ==
To set up the integration with Yoti, follow the steps below.
=== Setting up APIs ===
[[File:Image.png|thumb|Metadata Setup Example]]
Head over to Setup -> Custom Metadata -> <u>Identity Verification: Yoti Settings,</u> click on "Manage Records" and create a new instance called "Identity". This is the default instance required by the integration, but you can have multiple instances.
You will need to have set up a Public Site (usually /Onboarding guest site) as we need to retrieve the results from the processing.
When you create a new instance, most of the fields will be pre-populated for you, however you need to populate the following fields yourself:
* '''Requested Checks''' - a JSON configuration array for the types of checks requested. An example is given below.
<syntaxhighlight lang="json">
[{"type": "ID_DOCUMENT_AUTHENTICITY","config": {"manual_check": "FALLBACK"}},
{"type": "LIVENESS","config": {"liveness_type": "ZOOM","max_retries": 1}},
{"type": "ID_DOCUMENT_FACE_MATCH","config": {"manual_check": "FALLBACK"}}]
</syntaxhighlight>
* '''Requested Tasks''' - a JSON configuration array for the types of tasks requested. An example is given below.
<syntaxhighlight lang="json">
[{"type": "ID_DOCUMENT_TEXT_DATA_EXTRACTION","config": {"manual_check": "FALLBACK","chip_data": "DESIRED"}}]
</syntaxhighlight>
* '''Private Key''' - can be obtained by 3B or directly with Yoti
* '''Client SDK ID Key''' - can be obtained by 3B or directly with Yoti
* '''Results Callback''' - must be populated with the Public URL + REST Endpoint (/services/apexrest/b3o/IV_Yoti_Client/v1/results)
=== Set up Public Site Permissions ===
Since we depend on the Public Site to get the results of the checks, you need to grant access to all of the APEX classes that start with b3o.IV_Yoti for the selected public site you are configuring with the integration
=== Set up Document Pack ===
Create a new [[Document Packs|Document Pack]] or edit an existing one. Create a new document and set the External URL to your Public Site + /b3o__IdentityVerification?contactId={0}&documentId={1}&applicationId={2}. Example: https://org.my.salesforce-sites.com/onboarding/IdentityVerification?contactId={0}&documentId={1}&applicationId={2}
=== Send as Link ===
Remember that you can also send the identity verification as a stand-alone link, not attached to a document pack, just make sure yo merge the contactId variable with that of the intended recipient.
== Identity Verification Record ==
[[File:Identity Verification Record.png|thumb|Identity Verification Record]]
Once a candidate completes an Identity Verification workflow with Yoti, an Identity Verification record (b3o__Identity_Verification__c) is created against their contact record. If configured, an LWC component "Identity Verification" will be placed on the app page that will be breaking down the results from the identity verification process.
The documents supplied during the collection stage will be visible against the record, however the actual files will not be stored in Salesforce.
If you want to pull the files into Salesforce, you would need to view the document by clicking on the "view" icon and then click on "Save to Salesforce". This will create the file and link it to the contextual Identity Verification record.
[[File:Document Supplied.png|thumb|Supplied Document View]]


== Supported Languages ==
== Supported Languages ==
Retrieved from ‘https://3bknowhow.com/wiki/Special:MobileDiff/205’

Navigation menu