[KYC-Match]: Having a match with true should be defined as a perfect match with a score of 100

[maxl2287]

When I want to implement this API, what should be the expectation:

• true = 100 score, as it is written that it matches the value from the operator system ?

From my PoV this should be the way, as otherwise it would not be a "match".

What is your opinion about that?

Thanks in advance.

[HuubAppelboom]

This is by definition the case. The matchscore is only returned is the match result is false, and is somewhere between 0 and 99.
In case the match is true, there is no need to return the score.
The matchscore is usefull in case there are small typing errors on eiher side (API Consumer or API Provider).

[ToshiWakayama-KDDI]

Thank you @maxl2287 , @HuubAppelboom . I agree with you. The match score is expected to be between 0 and 99, but the Match API Yaml says "minimum: 0, maximum: 100". This should be corrected to 'maximum: 99', shouldn't it?

BR
Toshi

[HuubAppelboom]

@ToshiWakayama-KDDI In practice you would never return 100 (because then there would be a match). The documentation is correct, here it states:
"The range of score values is between "0" and "100", where higher scores indicate a higher similarity between the two compared parameters."

But you may want to update the definitions of the response body, there it says currently integer (MatchScoreResult) [ 0 .. 100 ], which should be [0..99]. Or will that confuse people and think that 99 = perfect match ??

Regards
Huub

[maxl2287]

@ToshiWakayama-KDDI In practice you would never return 100 (because then there would be a match). The documentation is correct, here it states: "The range of score values is between "0" and "100", where higher scores indicate a higher similarity between the two compared parameters."

But you may want to update the definitions of the response body, there it says currently integer (MatchScoreResult) [ 0 .. 100 ], which should be [0..99]. Or will that confuse people and think that 99 = perfect match ??

Regards Huub

From my point of view (as a developer) it's more confusing saying:

Indicates the similarity score assigned to the input value when it does not exactly match the value stored in the operator's system. This property shall only be returned when the value of the corresponding match field is false.
But the maximum is 100.

What should be more a "match" than 100? What should the customer then change?

So yes, I would propose a set of the maximum to 100, but also I would like to have it described that a internally calculated score of 100 is defined as a match (or something similiar)

[HuubAppelboom]

I think we can solve any ambiguity simply by adding in the documentation that "A perfect match is defined as score 100".

[GillesInnov35]

hi, I agree, we could add this sentence in the description to avoid any question.
Thanks

[maxl2287]

@GillesInnov35 Can you convert this discussion into an issue?
Then I can create a PR for it, if this is okay with you.

cc @ToshiWakayama-KDDI @fernandopradocabrillo

[fernandopradocabrillo]

done!