summaryrefslogtreecommitdiff
path: root/core/api-exchange.rst
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2022-08-14 18:28:42 +0200
committerChristian Grothoff <christian@grothoff.org>2022-08-14 18:28:42 +0200
commitef60d1e66d3c996d6b46c4a415c359e28863f7d6 (patch)
treeee388eeeda6fb763bfff6aab52154b98ed9858be /core/api-exchange.rst
parentaf59f3fb9f6a1dc1157df894f2ccb3ab950c5690 (diff)
downloaddocs-ef60d1e66d3c996d6b46c4a415c359e28863f7d6.tar.gz
docs-ef60d1e66d3c996d6b46c4a415c359e28863f7d6.tar.bz2
docs-ef60d1e66d3c996d6b46c4a415c359e28863f7d6.zip
update KYC API documentation
Diffstat (limited to 'core/api-exchange.rst')
-rw-r--r--core/api-exchange.rst28
1 files changed, 10 insertions, 18 deletions
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
index 02addfcb..86b12ad0 100644
--- a/core/api-exchange.rst
+++ b/core/api-exchange.rst
@@ -1331,14 +1331,6 @@ exchange.
// Balance left in the reserve.
balance: Amount;
- // True if the owner of the account currently satisfies
- // the required KYC checks.
- kyc_passed: boolean;
-
- // True if the reserve history includes a merge of a purse
- // and thus the owner must pass KYC checks before withdrawing.
- kyc_required: boolean;
-
// Transaction history for this reserve.
// May be partial (!).
history: TransactionHistoryItem[];
@@ -3327,10 +3319,15 @@ typically also view the balance.)
// Legitimization target that the merchant should
// use to check for its KYC status using
// the ``/kyc-check/$LEGITIMIZATION_UUID`` endpoint.
- legitimization_uuid: Integer;
+ // Optional, not present if the deposit has not
+ // yet been aggregated to the point that a KYC
+ // need has been evaluated.
+ legitimization_uuid?: Integer;
// True if the KYC check for the merchant has been
- // satisfied.
+ // satisfied. False does not mean that KYC
+ // is strictly needed, unless also a
+ // legitimization_uuid is provided.
kyc_ok: boolean;
// Time by which the exchange currently thinks the deposit will be executed.
@@ -3782,7 +3779,7 @@ Wallet-to-wallet transfers
:http:statuscode:`451 Unavailable For Legal Reasons`:
This account has not yet passed the KYC checks.
The client must pass KYC checks before proceeding with the merge.
- FIXME: not yet implemented, response format to be specified!
+ The response will be an `KycNeededRedirect` object.
**Details:**
@@ -3893,7 +3890,7 @@ Wallet-to-wallet transfers
:http:statuscode:`451 Unavailable For Legal Reasons`:
This account has not yet passed the KYC checks.
The client must pass KYC checks before proceeding with the merge.
- FIXME: not yet implemented, response format to be specified!
+ The response will be an `KycNeededRedirect` object.
**Details:**
@@ -4179,11 +4176,6 @@ wallet-to-wallet payments. Only another exchange should access this endpoint.
KYC status updates
------------------
- .. note::
-
- This is a draft API that is not yet implemented.
-
-
.. http:POST:: /kyc-wallet
Setup KYC identification for a wallet. Returns the KYC UUID.
@@ -4230,7 +4222,7 @@ KYC status updates
// UUID that the wallet should use when initiating
// the KYC check.
- payment_target_uuid: number;
+ legitimization_uuid: number;
}