search

camaraproject / KnowYourCustomer

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

Create a common enum for attributeMatch result #96

Open GillesInnov35 opened 3 weeks ago

GillesInnov35 commented 3 weeks ago

Problem description a dedicated enum (True/Flasi/not-available) is declared for each attributeMatch result

Expected behavior Declare a common enum as a schema and referred in each attribute description

Additional context This should strongly facilitate developers' API implementation.

Thanks

GillesInnov35 commented 2 weeks ago

hi @all,

in order to explain in more details see below code example with a enum MatchResult which should be referenced by all attribute schema description in the response.

MatchResult: type: string description: enumeration of match result enum:

  • 'true'
  • 'false'
  • 'not_available'
KYC_MatchResponse:
  type: object
  properties:

    idDocumentMatch:
      $ref: '#/components/schemas/MatchResult'

    nameMatch:
      $ref: '#/components/schemas/MatchResult'

    givenNameMatch:
      $ref: '#/components/schemas/MatchResult'

BR Gilles