commit 34bd4398b0b2b6c0db23f48b60047c0fe43cd452 parent c603e6d873a95d7545bf7addb565b465ab1afcec Author: Christian Grothoff <christian@grothoff.org> Date: Sat, 16 Oct 2021 19:40:07 +0200 specify new /kyc-wallet endpoint Diffstat:
| M | core/api-exchange.rst | | | 45 | +++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 45 insertions(+), 0 deletions(-)
diff --git 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.