Skip to content
This repository has been archived by the owner on Apr 16, 2020. It is now read-only.

Added KYC purpose #576

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added KYC purpose #576

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions spec/components/schemas/KycDocument.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ properties:
enum:
- identity-proof
- address-proof
purpose:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make sense to restrict this field to a nullable enum ?

I can not imagine too many reasons to request a KYC check (basically it can serve the purpose of accepting a customer or to send money to someone). Having an enum would also allow us to get an understanding of what is the most common use of this tool.

Also, we always can evolve from an enum to a string while the opposite would be more difficult.
I am not sure enough about all the possible values the enum could accept, though.

Copy link
Member Author

@adamaltman adamaltman Jan 17, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It may make sense. Maybe these:

- acceptance
- remittance
- investor
- other

What do you think of those possible values?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those values seem ok to me as a starting point.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adamaltman Those possibilities seem okay for now. We can always add to or change the enum if needed.

description: A brief description of the purpose (eg purchase verification, payout verification).
type: string
example: purchase
nullable: true
status:
description: Status of the validation
type: string
Expand Down