GET /aml/$OFFICER_PUB

Return information about the authenticated AML officer. This endpoint is used by AML staff applications to verify enrollment and determine whether write operations are permitted.

This endpoint was introduced in protocol v40.

Request:

Taler-AML-Officer-Signature:

The client must provide a Base-32 encoded EdDSA signature made with $OFFICER_PRIV that affirms the desire to obtain AML data. As with the other AML GET endpoints, this is an authentication signature and does not bind the details of the request.

Response:

200 Ok:

The AML officer is active. The response contains an AmlOfficerInfo object.

400 Bad Request:

The public key is malformed or the required signature header is missing or malformed.

403 Forbidden:

The signature is invalid, or the AML officer is unknown or inactive. Invalid signatures use TALER_EC_EXCHANGE_GENERIC_AML_OFFICER_GET_SIGNATURE_INVALID; unknown or inactive officers use TALER_EC_EXCHANGE_GENERIC_AML_OFFICER_ACCESS_DENIED.

500 Internal server error:

The exchange failed to read the AML officer record from its database.

Details:

interface AmlOfficerInfo {

  // Legal name configured for this AML officer.
  officer_name: string;

  // True if the officer may read AML data but may not submit AML
  // decisions. False grants both read and write access.
  read_only: boolean;

}