diff options
author | Christian Grothoff <christian@grothoff.org> | 2024-04-19 15:55:16 +0200 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2024-04-19 15:55:16 +0200 |
commit | 67e6516a51af264e260490b596b9ab7c6d100e63 (patch) | |
tree | ba11d3c595697b37f3a6d169c8d6ff4244e60675 /design-documents | |
parent | 4e88432b2de58f09a4ceb84434ce03f649fb1692 (diff) | |
download | docs-67e6516a51af264e260490b596b9ab7c6d100e63.tar.gz docs-67e6516a51af264e260490b596b9ab7c6d100e63.tar.bz2 docs-67e6516a51af264e260490b596b9ab7c6d100e63.zip |
improve KYC spec
Diffstat (limited to 'design-documents')
-rw-r--r-- | design-documents/023-taler-kyc.rst | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/design-documents/023-taler-kyc.rst b/design-documents/023-taler-kyc.rst index 28f49461..0ecfc4aa 100644 --- a/design-documents/023-taler-kyc.rst +++ b/design-documents/023-taler-kyc.rst @@ -275,7 +275,7 @@ New Endpoints :query timeout_ms=NUMBER: *Optional.* If specified, the exchange will wait up to ``timeout_ms`` milliseconds if the requirement continues to be mandatory provisioning of KYC data by the client. - Ignored if the HTTP status code is already `200 Ok`. Note that + Ignored if the HTTP status code is already ``200 Ok``. Note that clients cannot long-poll for AML staff actions, so status information about an account being under AML review needs to be requested periodically. @@ -288,7 +288,7 @@ New Endpoints The response will be an `AccountKycStatus` object which specifies restrictions that currently apply to the account. If the client attempts to exceed *soft* limits, the status may change - to a `202 Accepted`. Hard limits cannot be lifted by passing KYC checks. + to a ``202 Accepted``. Hard limits cannot be lifted by passing KYC checks. :http:statuscode:`202 Accepted`: The account holder performed an operation that would have crossed *soft* limits and must be redirected to the provided location to perform @@ -328,8 +328,8 @@ New Endpoints // URL that the user should open in a browser to // proceed with the KYC process (optional if - // the status type is 200 Ok, mandatory if the - // HTTP status is 202 Accepted). + // the status type is ``200 Ok``, mandatory if the + // HTTP status is ``202 Accepted``). kyc_url: string; // Array with limitations that currently apply to this @@ -897,7 +897,7 @@ providers, one per configuration section: # ';'-separated list of fields that the CONTEXT must # provided as inputs to this check. For example, # for a FORM of type CHOICE, this might state - # ``choices: String[];``. The type after the ":" + # ``choices: string[];``. The type after the ":" # is for now purely for documentation and is # not checked. However, it may be shown to AML staff # when they configure measures. @@ -1090,7 +1090,7 @@ AML programs are helper programs that can: interface KycRule { // Type of operation to which the rule applies. - operation_type: String; + operation_type: string; // Measure to be taken if the given // threshold is crossed over the given timeframe. @@ -1105,7 +1105,7 @@ AML programs are helper programs that can: // custom measures from the `AmlProgramOutcome`. // A special measure "verboten" is used if the // threshold may never be crossed. - measures: String[]; + measures: string[]; // True if the rule (specifically, operation_type, // threshold, timeframe) and the general nature of @@ -1317,7 +1317,7 @@ on GET ``/deposits/`` with the respective legitimization requirement row. ,expiration_time INT8 NOT NULL DEFAULT (0) ,legitimization_measure_serial_id BIGINT REFERENCES legitimization_measures (legitimization_measure_serial_id) - ,measure_index INT8' + ,measure_index INT8 ,provider_section VARCHAR NOT NULL ,provider_user_id VARCHAR DEFAULT NULL ,provider_legitimization_id VARCHAR DEFAULT NULL @@ -1490,14 +1490,14 @@ exteral KYC check and redirecting there. FORM is about displaying a particular exchange. Here we describe the forms that must be supported: * CHOICE: Asks the client a multiple-choice question. - The context must include "choices: String[]" with + The context must include "choices: string[]" with a list of choices to show. Used, for example, to ask a client if they are an individual or a business. The resulting HTML FORM field name must be "choice" and it must be mapped to strings from the choices list. * UPLOAD: Asks the client to upload a single file. - The context may include "extensions: String[]" with + The context may include "extensions: string[]" with a list of allowed file extensions the client's file must end with (e.g. "png", "pdf", "gif"). In the absence of this context, any file may be uploaded. |