taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

get-reserves-RESERVE_PUB-attest.rst (1415B)

      1 .. http:get:: /reserves/$RESERVE_PUB/attest
      2 
      3   Request list of available KYC attributes about the owner of a reserve.
      4   Used as a preliminary step to find out which subsets of attributes the
      5   exchange could provide signatures over.
      6 
      7   **Response:**
      8 
      9   :http:statuscode:`200 OK`:
     10     The exchange responds with a `ReserveKycAttributesAvailableResponse`
     11     object.
     12   :http:statuscode:`400 Bad Request`:
     13     The ``$RESERVE_PUB`` is malformed.
     14     This response comes with a standard `ErrorDetail` response with
     15     a code of ``TALER_EC_GENERIC_RESERVE_PUB_MALFORMED``.
     16   :http:statuscode:`404 Not found`:
     17     The reserve key does not belong to a reserve known to the exchange.
     18     This response comes with a standard `ErrorDetail` response with
     19     a code of ``TALER_EC_EXCHANGE_GENERIC_RESERVE_UNKNOWN``.
     20   :http:statuscode:`409 Conflict`:
     21     The exchange does not have the requested KYC information.
     22   :http:statuscode:`500 Internal Server Error`:
     23     The server experienced an internal error.
     24     This response comes with a standard `ErrorDetail` response with
     25     a code of ``TALER_EC_GENERIC_DB_FETCH_FAILED``.
     26 
     27   **Details:**
     28 
     29   .. ts:def:: ReserveKycAttributesAvailableResponse
     30 
     31     interface ReserveKycAttributesAvailableResponse {
     32       // Array of KYC attributes available.  The attribute names
     33       // listed are expected to be from the respective GANA
     34       // registry.
     35       details: string[];
     36     }