commit c089038fbc1d32c497ae6355c8661e3405b33b2b
parent fc463328c5e9b48c1ea387144ea6d2682faba86c
Author: Christian Grothoff <christian@grothoff.org>
Date: Sun, 8 Sep 2024 22:49:03 +0200
update spec for KYC endpoints with long-polling
Diffstat:
2 files changed, 15 insertions(+), 1 deletion(-)
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
@@ -4775,6 +4775,12 @@ regulatory compliance.
either the (wallet long-term) reserve private key or the merchant instance
private key.
+ :query lpt=TARGET: *Optional*.
+ Specifies what status change we are long-polling for.
+ Use 1 to wait for the KYC auth transfer (access token available),
+ 2 to wait for an AML investigation to be done,
+ and 3 to wait for the KYC status to be OK.
+ Since protocol **v21**.
: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.
@@ -4782,7 +4788,6 @@ regulatory compliance.
clients cannot long-poll for AML staff actions, so status information
about an account being under AML review needs to be requested
periodically.
- :query await_auth=YNA: *Optional.* Defaults to "NO". If set to "YES", the exchange will long-poll for a KYC auth wire transfer. Otherwise, long-polling will be for a change of the KYC check requirements to "satisfied". Since protocol **v21**.
**Response:**
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -1447,6 +1447,15 @@ KYC status checks
:query h_wire=H_WIRE: *Optional*. If specified, the KYC check should return the KYC status only for this wire account. Otherwise, for all wire accounts.
:query exchange_url=URL: *Optional*. If specified, the KYC check should return the KYC status only for the given exchange. Otherwise, for all exchanges we interacted with.
+ :query lpt=TARGET: *Optional*.
+ Specifies what status change we are long-polling for.
+ Use 1 to wait for the KYC auth transfer (access token available),
+ 2 to wait for an AML investigation to be done,
+ and 3 to wait for the KYC status to be OK.
+ If multiple accounts or exchanges match the query,
+ any account reaching the TARGET state will cause
+ the response to be returned.
+ Since protocol **v17**.
:query timeout_ms=NUMBER: *Optional.* If specified, the merchant will
wait up to ``timeout_ms`` milliseconds for the exchanges to confirm completion of the KYC process(es).
