Name Similarity Check
This module compares names from two documents and gives a score showing how similar they are. It helps check for any differences between the names, making it easier to confirm whether the documents belong to the same person.
How to Setup
1 Navigate to Workspace > Workflows, and click on the flow created for Name Similarity Check. If you need understanding in creating a workflow, refer to the step-by-step guide here.
Ensure that preceding workflows are added, only then can the Name Similarity Check workflow module compare the names with the claims from previously completed workflows. For instance, Verify Aadhaar and Verify PAN are used here.
2 Hover over the plus (+) symbol and select Workflow. From the list, click Name Similarity Check to add it.
3 Click on the newly added workflow, then select the General tab to customize your preferences.
Manage General
(*) Indicates an action to be mandatory.
| Name | Description |
|---|---|
| Display Name* | Set a name to the workflow for easy identification. |
| Description | Summarize the purpose and functionality of this workflow module. |
| Enable | This toggle is enabled by default. When enabled, the particular workflow module begins its execution. Conversely, if disabled, the workflow module remains inactive and won't proceed. |
| Skip | Allows the user to skip this specific workflow module during execution. When selected, it provides an option to bypass the particular workflow without affecting other modules in the sequence. |
| Rule | This determines the criteria for triggering the particular workflow module. When the selected rule is evaluated, and is satisfied, the workflow proceeds as provided. If not, the workflow will not be executed. Note: If no rules are set, the workflow defaults to its standard action without any rule. For more information about the rules, refer here. |
4 Then, click on the Configs tab to set the necessary configurations.
Manage Configs
(*) Indicates an action to be mandatory.
| Name | Description |
|---|---|
| Title* | Provide an appropriate title to be displayed in the verification page. |
| Description | Provide the description to be displayed to the user during the verification process. |
| First Name to be Compared | Enter the first name to be compared for a match. |
| Second Name to be Compared | Enter the second name to be compared for a match. |
5 After you've configured everything needed, click on SAVE.
6 Proceed to attach the workflow to the relevant application for execution. Refer to the instructions on how to attach a workflow to an application here.
Expected Result
Based on the provided configuration, the information that will be fetched for Name Similarity Check includes the following parameters:
| Name | Description |
|---|---|
first_name_to_be_scored | First name used for similarity comparison. |
second_name_to_be_scored | Second name used for similarity comparison. |
score | Numeric value representing the similarity between the two names. |
The response received will include the accurate information mentioned above. Note that, the response values can vary depending on the specific workflow modules.
How it Works
1 Launch Postman or your preferred API tool and execute the flow by configuring the suitable Method, URL, and Body settings. If you're seeking guidance on how to perform these actions, see here.
2 Upon initiating the API call, a verification request will be sent to your configured Verification Way settings.
3 Based on the request, execute the flow in an incognito browser and follow the prompts to complete the verification process.
4 Since Verify PAN and Verify Aadhaar with OTP are set as preceding workflows, start by entering the required details and click Submit.
5 After completing both workflows, the name comparison process will begin.
6 The verification process will be completed.
If "force onboarding" is enabled in the API request, all users, regardless of status, will be directed to the onboarding flow first, followed by the verification flow if configured.
7 The response can differ depending on the chosen Verification Way and Notification Way configurations. To know more, see here.
8 Here is a sample response for Name Similarity Check:
{
"request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
"workflow": "verification",
"user_id": "mark@gmail.com",
"lastName": "ROBERT",
"pan_verified_at": "1738909975",
"aadhaar_number_otp": "857xxxxxxx",
"panStatus": "VALID",
"pan_number": "IDxxxxxxx",
"full_name": "Mark R",
"aadhaar_otp_verified": "true/false",
"aadhaar_otp_verified_at": "1738910033",
"name": "ROBERT MARK",
"middleName": "",
"pan_verified": "true/false",
"documentation_check_first_name_to_be_scored": "ROBERT MARK",
"docs_check_second_name_to_be_scored": "Mark R",
"docs_check_score": "57.95"
}