diff options
author | Christian Grothoff <christian@grothoff.org> | 2024-04-23 12:56:05 +0200 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2024-04-23 12:56:05 +0200 |
commit | a5869e599c206aa0ba0eeccd02cb517594bb0495 (patch) | |
tree | 9fa36cac760b63e287e16fd0dc37320a8b5cd49e /design-documents | |
parent | b2fd4bbb2e34d1df85a22e467b5aca5d64c39975 (diff) | |
download | docs-a5869e599c206aa0ba0eeccd02cb517594bb0495.tar.gz docs-a5869e599c206aa0ba0eeccd02cb517594bb0495.tar.bz2 docs-a5869e599c206aa0ba0eeccd02cb517594bb0495.zip |
-formatting
Diffstat (limited to 'design-documents')
-rw-r--r-- | design-documents/023-taler-kyc.rst | 68 |
1 files changed, 43 insertions, 25 deletions
diff --git a/design-documents/023-taler-kyc.rst b/design-documents/023-taler-kyc.rst index c3a32a5e..c00a7532 100644 --- a/design-documents/023-taler-kyc.rst +++ b/design-documents/023-taler-kyc.rst @@ -646,13 +646,14 @@ New endpoints **Request**: - *If-None-Match*: + *If-None-Match*: - The client MAY provide an ``If-None-Match`` header with an ETag. + The client MAY provide an ``If-None-Match`` header with an ETag. - :query timeout_ms=MILLISECONDS: *Optional.* If specified, the exchange - will wait up to MILLISECONDS for a change to a more recent legitimization - measure before returning a 304 Not Modified status. + :query timeout_ms=MILLISECONDS: + *Optional.* If specified, the exchange will wait up to MILLISECONDS for + a change to a more recent legitimization measure before returning a 304 + Not Modified status. **Response**: @@ -771,6 +772,8 @@ New endpoints The KYC process was successfully initiated. The URL is in a `KycProcessStartInformation` object. + **Details:** + .. ts:def:: KycProcessStartInformation interface KycProcessStartInformation { @@ -817,8 +820,10 @@ New endpoints If the KYC plugin logic is OAuth 2.0, the query parameters are: - :query code=CODE: OAuth 2.0 code argument. - :query state=STATE: OAuth 2.0 state argument with the H_PAYTO. + :query code=CODE: + OAuth 2.0 code argument. + :query state=STATE: + OAuth 2.0 state argument with the H_PAYTO. .. note:: @@ -967,6 +972,8 @@ New endpoints Information about possible measures is returned in a `AvailableMeasureSummary` object. + **Details:** + .. ts:def:: AvailableMeasureSummary interface AvailableMeasureSummary { @@ -1055,15 +1062,18 @@ New endpoints **Request**: - *Taler-AML-Officer-Signature*: The client must provide Base-32 encoded EdDSA - signature with ``$OFFICER_PRIV``, affirming the desire to obtain AML data. - Note that this is merely a simple authentication mechanism, the details of - the request are not protected by the signature. + *Taler-AML-Officer-Signature*: + The client must provide Base-32 encoded EdDSA signature with + ``$OFFICER_PRIV``, affirming the desire to obtain AML data. Note that this + is merely a simple authentication mechanism, the details of the request are + not protected by the signature. - :query start_date=TIMESTAMP: *Optional*. Specifies the date when to + :query start_date=TIMESTAMP: + *Optional*. Specifies the date when to start looking (inclusive). If not given, the start time of the exchange operation is used. - :query end_date=TIMESTAMP: *Optional*. Specifies the date when to + :query end_date=TIMESTAMP: + *Optional*. Specifies the date when to stop looking (exclusive). If not given, the current date is used. **Response**: @@ -1081,15 +1091,20 @@ New endpoints Obtain list of AML decisions (filtered by $STATE). ``$STATE`` must be either ``normal``, ``pending`` or ``frozen``. - *Taler-AML-Officer-Signature*: The client must provide Base-32 encoded EdDSA - signature with ``$OFFICER_PRIV``, affirming the desire to obtain AML data. - Note that this is merely a simple authentication mechanism, the details of - the request are not protected by the signature. + **Request** - :query limit: *Optional*. takes value of the form ``N (-N)``, so that at + *Taler-AML-Officer-Signature*: + The client must provide Base-32 encoded EdDSA signature with + ``$OFFICER_PRIV``, affirming the desire to obtain AML data. Note that + this is merely a simple authentication mechanism, the details of the + request are not protected by the signature. + + :query limit: + *Optional*. takes value of the form ``N (-N)``, so that at most ``N`` values strictly older (younger) than ``start`` are returned. Defaults to ``-20`` to return the last 20 entries (before ``start``). - :query offset: *Optional*. Row number threshold, see ``delta`` for its + :query offset: + *Optional*. Row number threshold, see ``delta`` for its interpretation. Defaults to ``INT64_MAX``, namely the biggest row id possible in the database. @@ -1140,13 +1155,16 @@ New endpoints Obtain deails about an AML decision. - *Taler-AML-Officer-Signature*: The client must provide a Base-32 - encoded EdDSA signature with ``$OFFICER_PRIV``, affirming the - desire to obtain AML data. Note that this is merely a simple - authentication mechanism, the details of the request are not - protected by the signature. + **Request** + + *Taler-AML-Officer-Signature*: + The client must provide a Base-32 encoded EdDSA signature with + ``$OFFICER_PRIV``, affirming the desire to obtain AML data. Note that + this is merely a simple authentication mechanism, the details of the + request are not protected by the signature. - :query history: *Optional*. If set to yes, we return all historic + :query history: + *Optional*. If set to yes, we return all historic decisions for the account, and not only the last one. **Response** |