taler-docs

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

post-management-aml-officers.rst (1478B)

      1 .. http:post:: /management/aml-officers
      2 
      3   Update settings for an AML Officer status.
      4 
      5   **Request:**
      6 
      7   The request must be an `AmlOfficerSetup` message.
      8 
      9   **Response:**
     10 
     11   :http:statuscode:`204 No content`:
     12     The officer settings have been updated successfully.
     13   :http:statuscode:`403 Forbidden`:
     14     The signature is invalid.
     15     Returned with an error code of
     16     ``TALER_EC_EXCHANGE_MANAGEMENT_UPDATE_AML_OFFICER_SIGNATURE_INVALID``
     17   :http:statuscode:`409 Conflict`:
     18     The exchange has previously received a conflicting configuration message.
     19     Returned with an error code of
     20     ``TALER_EC_EXCHANGE_MANAGEMENT_AML_OFFICERS_MORE_RECENT_PRESENT``
     21   :http:statuscode:`413 Request entity too large`:
     22     The uploaded body is to long, it exceeds the size limit.
     23     Returned with an error code of
     24     ``TALER_EC_GENERIC_UPLOAD_EXCEEDS_LIMIT``.
     25 
     26   **Details:**
     27 
     28   .. ts:def:: AmlOfficerSetup
     29 
     30     interface AmlOfficerSetup {
     31 
     32       // Public key of the AML officer
     33       officer_pub: EddsaPublicKey;
     34 
     35       // Legal full name of the AML officer
     36       officer_name: string;
     37 
     38       // Is the account active?
     39       is_active: boolean;
     40 
     41       // Is the account read-only?
     42       read_only: boolean;
     43 
     44       // Signature by the exchange master key over a
     45       // `TALER_MasterAmlOfficerStatusPS`.
     46       // Must have purpose ``TALER_SIGNATURE_MASTER_AML_KEY``.
     47       master_sig: EddsaSignature;
     48 
     49       // When will the change take effect?
     50       change_date: Timestamp;
     51 
     52     }