get-aml-OFFICER_PUB.rst (1603B)
1 .. http:get:: /aml/$OFFICER_PUB 2 3 Return information about the authenticated AML officer. This endpoint is 4 used by AML staff applications to verify enrollment and determine whether 5 write operations are permitted. 6 7 This endpoint was introduced in protocol **v40**. 8 9 **Request:** 10 11 *Taler-AML-Officer-Signature*: 12 The client must provide a Base-32 encoded EdDSA signature made with 13 ``$OFFICER_PRIV`` that affirms the desire to obtain AML data. As with the 14 other AML GET endpoints, this is an authentication signature and does not 15 bind the details of the request. 16 17 **Response:** 18 19 :http:statuscode:`200 Ok`: 20 The AML officer is active. The response contains an 21 `AmlOfficerInfo` object. 22 :http:statuscode:`400 Bad Request`: 23 The public key is malformed or the required signature header is missing or 24 malformed. 25 :http:statuscode:`403 Forbidden`: 26 The signature is invalid, or the AML officer is unknown or inactive. 27 Invalid signatures use 28 ``TALER_EC_EXCHANGE_GENERIC_AML_OFFICER_GET_SIGNATURE_INVALID``; unknown 29 or inactive officers use 30 ``TALER_EC_EXCHANGE_GENERIC_AML_OFFICER_ACCESS_DENIED``. 31 :http:statuscode:`500 Internal server error`: 32 The exchange failed to read the AML officer record from its database. 33 34 **Details:** 35 36 .. ts:def:: AmlOfficerInfo 37 38 interface AmlOfficerInfo { 39 40 // Legal name configured for this AML officer. 41 officer_name: string; 42 43 // True if the officer may read AML data but may not submit AML 44 // decisions. False grants both read and write access. 45 read_only: boolean; 46 47 }