summaryrefslogtreecommitdiff
path: root/man/taler.conf.5
diff options
context:
space:
mode:
Diffstat (limited to 'man/taler.conf.5')
-rw-r--r--man/taler.conf.561
1 files changed, 39 insertions, 22 deletions
diff --git a/man/taler.conf.5 b/man/taler.conf.5
index a5088433..9c393d4c 100644
--- a/man/taler.conf.5
+++ b/man/taler.conf.5
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "TALER.CONF" "5" "Jul 06, 2022" "0.9" "GNU Taler"
+.TH "TALER.CONF" "5" "Nov 03, 2022" "0.9" "GNU Taler"
.SH NAME
taler.conf \- Taler configuration file
.
@@ -205,39 +205,39 @@ Works the same as \fBTERMS_DIR\fP, just for the privacy policy.
.TP
.B PRIVACY_ETAG
Works the same as \fBTERMS_ETAG\fP, just for the privacy policy.
+.UNINDENT
+.SS EXCHANGE KYC PROVIDER OPTIONS
+.sp
+The following options must be in the section "[kyc\-provider\-XXX]" sections.
+.INDENT 0.0
+.TP
+.B COST
+Relative cost of the KYC provider, non\-negative number.
.TP
-.B 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.
-.TP
-.B KYC_WITHDRAW_LIMIT
-Maximum amount that can be withdrawn in
-KYC_WITHDRAW_PERIOD without needing KYC.
-Only used if KYC_MODE is not "NONE".
-.TP
-.B KYC_WITHDRAW_PERIOD
-The time period over which transactions
-are considered for the KYC_WITHDRAW_LIMIT.
-Only used if KYC_MODE is not "NONE".
-.TP
-.B 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.
+.B LOGIC
+API type of the KYC provider.
+.TP
+.B USER_TYPE
+Type of user this provider is for, either INDIVIDUAL or BUSINESS.
+.TP
+.B PROVIDED_CHECKS
+List of checks performed by this provider. Space\-separated names of checks, must match check names in legitimization rules.
.UNINDENT
.SS EXCHANGE KYC OAUTH2 OPTIONS
.sp
-The following options must be in the section "[exchange\-kyc\-oauth2]".
+The following options must be in the section "[kyc\-provider\-XXX]" sections with "LOGIC = oauth2".
.INDENT 0.0
.TP
+.B KYC_OAUTH2_VALIDITY
+Duration (e.g. "12 months") of the validity of the performed KYC check. Can be "forever".
+.TP
.B KYC_OAUTH2_AUTH_URL
URL of the OAuth2 endpoint to be used for KYC checks. Requires KYC_ENABLED to be "OAUTH2". Example: "\fI\%http://localhost:8888/oauth/v2/login\fP" (or "/token")
.TP
.B KYC_OAUTH2_LOGIN_URL
URL of the OAuth2 endpoint to be used for KYC checks. Requires KYC_ENABLED to be "OAUTH2". Example: "\fI\%http://localhost:8888/oauth/v2/login\fP"
.TP
-.B KYC_INFO_URL
+.B KYC_OAUTH2_INFO_URL
URL of the endpoint where the OAuth 2.0 token can be used to download the user\(aqs details. Requires KYC_ENABLED to be "OAUTH2". Example: "\fI\%http://localhost:8888/api/user/me\fP"
.TP
.B KYC_OAUTH2_CLIENT_ID
@@ -249,6 +249,23 @@ Client secret of the exchange to use when talking to the KYC Oauth2 endpoint. Re
.B KYC_OAUTH2_POST_URL
URL to which the exchange will redirect the client\(aqs browser after successful authorization/login for the KYC process.
.UNINDENT
+.SS EXCHANGE KYC KYCAID OPTIONS
+.sp
+The following options must be in the section "[kyc\-provider\-XXX]" sections with "LOGIC = kycaid".
+.INDENT 0.0
+.TP
+.B KYC_KYCAID_VALIDITY
+Duration (e.g. "12 months") of the validity of the performed KYC check. Can be "forever".
+.TP
+.B KYC_KYCAID_AUTH_TOKEN
+Authentication token to access the KYC service.
+.TP
+.B KYC_KYCAID_FORM_ID
+ID that specifies the form to use for the KYC process.
+.TP
+.B KYC_KYCAID_POST_URL
+URL to which the exchange will redirect the client\(aqs browser after successful authorization/login for the KYC process.
+.UNINDENT
.SS EXCHANGE OFFLINE SIGNING OPTIONS
.sp
The following options must be in the section "[exchange\-offline]".