summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2021-10-16 19:40:07 +0200
committerChristian Grothoff <christian@grothoff.org>2021-10-16 19:40:07 +0200
commit34bd4398b0b2b6c0db23f48b60047c0fe43cd452 (patch)
treeffb4d12802ae7c83aca67b825c80de086d08d0bf
parentc603e6d873a95d7545bf7addb565b465ab1afcec (diff)
downloaddocs-34bd4398b0b2b6c0db23f48b60047c0fe43cd452.tar.gz
docs-34bd4398b0b2b6c0db23f48b60047c0fe43cd452.tar.bz2
docs-34bd4398b0b2b6c0db23f48b60047c0fe43cd452.zip
specify new /kyc-wallet endpoint
-rw-r--r--core/api-exchange.rst45
1 files changed, 45 insertions, 0 deletions
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
index 7f4f57c..aa371f9 100644
--- a/core/api-exchange.rst
+++ b/core/api-exchange.rst
@@ -3320,6 +3320,51 @@ KYC status updates
This is a draft API that is not yet implemented.
+.. http:POST:: /kyc-wallet
+
+ Setup KYC identification for a wallet. Returns the KYC UUID.
+
+ **Request:**
+
+ The request body must be a `WalletKycRequest` object.
+
+ **Response:**
+
+ :http:statuscode:`200 Ok`:
+ A KYC ID was created.
+ The response will be a `WalletKycUuid` object.
+ :http:statuscode:`204 No Content`:
+ KYC is disabled at this exchange.
+ :http:statuscode:`401 Unauthorized`:
+ The provided signature is invalid.
+
+ **Details:**
+
+ .. ts:def:: WalletKycRequest
+
+ interface WalletKycRequest {
+
+ // EdDSA signature of the wallet affirming the
+ // request, must be of purpose
+ // ``TALER_SIGNATURE_WALLET_ACCOUNT_SETUP``
+ reserve_sig: EddsaSignature;
+
+ // long-term wallet reserve-account
+ // public key used to create the signature.
+ reserve_pub: EddsaPublicKey;
+ }
+
+ .. ts:def:: WalletKycUuid
+
+ interface WalletKycUuid {
+
+ // UUID that the wallet should use when initiating
+ // the KYC check.
+ payment_target_uuid: number;
+
+ }
+
+
.. http:GET:: /kyc-check/$PAYMENT_TARGET_UUID
Check or update KYC status of a particular payment target.