search

camaraproject / KnowYourCustomer

Repository to describe, develop, document and test the KnowYourCustomer API family
Apache License 2.0
9 stars 11 forks source link

KYC-Match: Clarification on handling of unsupported attributes? #168

Open scarrk opened 1 week ago

scarrk commented 1 week ago

What would be the expected response from the MNO when a request includes attributes (such as gender, email) in a KYC Match request, that are not supported?

1) For the attributes that are not supported, you return a 'not_available' in the response (rather than true, false) 2) You return an Error 400 InvalidArgument" 3) Other

Appreciate feedback from the community on how your implementations handle the above scenario.

GillesInnov35 commented 1 week ago

hi @scarrk, at Orange when a request includes attributes which belongs to the properties of the API but not supported by the MNO API, a matchResult is returned with "not_available". This is also what has been decided by the KYC project contributors. BR Gilles

HuubAppelboom commented 1 week ago

Hi @scarrk @GillesInnov35 Currently at KPN we provide a "not_available" if one ore more of the attributes is not available. This way you can still provide as much as possible market reach (and some items we have poor coverage, like gender etc.). In case there is no data at all available,. it may be better to provide an error code (otherwise you have to analyse the result that has been returned whether or not data has been available). Working with an error code may be simpler. On the other hand, if you want to charge based on what has been asked, you will need to do just that. So, there is also a connection here with what you want to charge. In case there is no data available at all, a 422 error may be the way to go (if you want to return an error, in line what is done with Sim Swap).

ToshiWakayama-KDDI commented 5 days ago

Hi @scarrk ,

  1. For the attributes that are not supported, you return a 'not_available' in the response (rather than true, false)

As Gilles mentioned, this is what we have decided. Originally it was captured in Issue #21 KYC Match - Match Result Response (for v0.1) , and also in Issue #85 [KYC Match] Scoring (no change confirmed for v0.2) .

Thanks. Toshi

claraserranosolsona commented 4 days ago

Hi @scarrk ,

As Gilles and Toshi mentioned, for the attributes that are not supported we return a 'not_available' in the response (rather than true, false)

Regards, Clara

KevScarr commented 4 days ago

@GillesInnov35 @HuubAppelboom @ToshiWakayama-KDDI @claraserranosolsona Many thanks all for the clarification. Happy for this item to be closed off.