Skip to content

Commit 40c3560

Browse files
daspiyushPiyush Dasaditya-67
authored
added details of name match data in api response and eSign notification response as an optional feature (#254)
* added details of name match data in api response and esign notification response as an optional feature * formatted code block with <CodeBlockWithCopy> tag * Remove extra characters --------- Co-authored-by: Piyush Das <piyushdas@Setus-MacBook-Pro.local> Co-authored-by: Aditya Gannavarapu <adityagannavarapu.67@gmail.com>
1 parent cc9cf24 commit 40c3560

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

content/data/esign/name-match.mdx

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,43 @@ Below are some sample accept and reject scenarios:
3434
3. If one name contains only initials (name1 = Rakesh Kumar Singh, name2 = R K S)
3535
4. If in the case of initials, the non-initial parts of the name do not match (name1 = Rakesh Kumar Singh, name2 = R K Sngh)
3636

37-
Please note that this feature is independent, and should you not opt for it, there will be no changes to the normal eSign flow.
37+
Apart from rejecting an eSign request on the basis of name match we also provide the option for you to receive the fuzzy name match scores in our API responses.
38+
This way you will be able to take the call to either accept or reject the request on the basis of scores received. This feature can also be configured during your onboarding process.
39+
40+
This data will be optionally available in the following ways:
41+
42+
1. <a href="https://docs.setu.co/data/esign/api-reference#/operation~GetSignatureRequestbyRequestID" target="_blank">Get signature request status</a>
43+
2. <a href="https://docs.setu.co/data/esign/notifications#notifications" target="_blank">eSign notification</a>
44+
45+
A sample name match data in API response and notification will look like this:
46+
47+
<CodeBlockWithCopy language="json">
48+
{`
49+
"signers": [
50+
{
51+
"nameMatchDetails": {
52+
"optimisticMatchOutput": {
53+
"match_percentage": 100.0,
54+
"match_type": "COMPLETE_MATCH"
55+
},
56+
"pessimisticMatchOutput": {
57+
"match_percentage": 100.0,
58+
"match_type": "COMPLETE_MATCH"
59+
}
60+
},
61+
}
62+
]
63+
`}
64+
</CodeBlockWithCopy>
65+
66+
Possible values for the `match_type` key:
67+
68+
1. COMPLETE_MATCH
69+
2. HIGH_PARTIAL_MATCH
70+
3. MODERATE_PARTIAL_MATCH
71+
4. LOW_PARTIAL_MATCH
72+
5. NO_MATCH
73+
74+
Please note that these features are independent, and should you not opt for it, there will be no changes to the normal eSign flow.
3875

3976
<WasPageHelpful />

0 commit comments

Comments
 (0)