diff options
| author | Christian Grothoff <christian@grothoff.org> | 2022-08-14 18:28:42 +0200 |
|---|---|---|
| committer | Christian Grothoff <christian@grothoff.org> | 2022-08-14 18:28:42 +0200 |
| commit | ef60d1e66d3c996d6b46c4a415c359e28863f7d6 (patch) | |
| tree | ee388eeeda6fb763bfff6aab52154b98ed9858be /manpages/taler.conf.5.rst | |
| parent | af59f3fb9f6a1dc1157df894f2ccb3ab950c5690 (diff) | |
| download | docs-ef60d1e66d3c996d6b46c4a415c359e28863f7d6.tar.gz docs-ef60d1e66d3c996d6b46c4a415c359e28863f7d6.tar.bz2 docs-ef60d1e66d3c996d6b46c4a415c359e28863f7d6.zip | |
update KYC API documentation
Diffstat (limited to 'manpages/taler.conf.5.rst')
| -rw-r--r-- | manpages/taler.conf.5.rst | 34 |
1 files changed, 15 insertions, 19 deletions
diff --git a/manpages/taler.conf.5.rst b/manpages/taler.conf.5.rst index cd70b317..f34e2a59 100644 --- a/manpages/taler.conf.5.rst +++ b/manpages/taler.conf.5.rst @@ -148,31 +148,27 @@ PRIVACY_DIR PRIVACY_ETAG Works the same as ``TERMS_ETAG``, just for the privacy policy. -KYC_MODE - Set to "NONE" to disable KYC for this exchange (but check with your lawyer first). - Set to "OAUTH2" to use OAuth2 for KYC. -KYC_WITHDRAW_LIMIT - Maximum amount that can be withdrawn in - KYC_WITHDRAW_PERIOD without needing KYC. - Only used if KYC_MODE is not "NONE". +EXCHANGE KYC PROVIDER OPTIONS +----------------------------- -KYC_WITHDRAW_PERIOD - The time period over which transactions - are considered for the KYC_WITHDRAW_LIMIT. - Only used if KYC_MODE is not "NONE". +The following options must be in the section "[kyc-provider-XXX]" sections. -KYC_WALLET_BALANCE_LIMIT - Maximum amount that a wallet is allowed to hold without - having to undergo the KYC process of the issuing - exchange. Optional option, if not given there - is no limit. +COST + Relative cost of the KYC provider, non-negative number. +LOGIC + API type of the KYC provider. +USER_TYPE + Type of user this provider is for, either INDIVIDUAL or BUSINESS. +PROVIDED_CHECKS + List of checks performed by this provider. Space-separated names of checks, must match check names in legitimization rules. EXCHANGE KYC OAUTH2 OPTIONS ---------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following options must be in the section "[kyc-provider-XXX]" sections with "LOGIC = oauth2". -The following options must be in the section "[exchange-kyc-oauth2]". KYC_OAUTH2_AUTH_URL @@ -181,7 +177,7 @@ KYC_OAUTH2_AUTH_URL KYC_OAUTH2_LOGIN_URL URL of the OAuth2 endpoint to be used for KYC checks. Requires KYC_ENABLED to be "OAUTH2". Example: "http://localhost:8888/oauth/v2/login" -KYC_INFO_URL +KYC_OAUTH2_INFO_URL URL of the endpoint where the OAuth 2.0 token can be used to download the user's details. Requires KYC_ENABLED to be "OAUTH2". Example: "http://localhost:8888/api/user/me" KYC_OAUTH2_CLIENT_ID |