Contents

GET /aml/$OFFICER_PUB/legitimizations#

Enables AML staff to see which legitimizations are pending or have been completed. returns a list of active or finished legitimization measures (by account).

This endpoint was introduced in protocol v23.

Request:

Taler-AML-Officer-Signature:

The client must provide Base-32 encoded EdDSA signature with $OFFICER_PRIV, affirming the desire to obtain AML data. Note that this is merely a simple authentication mechanism, the details of the request are not protected by the signature.

Query Parameters:

  • limit – Optional. takes value of the form N (-N), so that at most N values strictly older (younger) than start are returned. Defaults to -20 to return the last 20 entries (before start).

  • offset – Optional. Row number threshold, see limit for its interpretation. Defaults to INT64_MAX, namely the biggest row id possible in the database.

  • h_payto – Optional. Account selector using the normalized payto URI. All matching accounts are returned if this filter is absent, otherwise only decisions for this account.

  • active – Optional. If set to yes, only return active decisions, if no only decisions that have been superseded. Do not give (or use “all”) to see all decisions regardless of activity status.

Response:

200 Ok:

Information about possible measures is returned in a LegitimizationMeasuresListResponse object.

204 No content:

There are no matching legitimization measures.

400 Bad Request:

The request is malformed. Cases include: - The $H_OFFICER_PUB path segment is malformed.

This response comes with a standard ErrorDetail response with a code of TALER_EC_GENERIC_PATH_SEGMENT_MALFORMED.

  • The required HTTP header with the signature is missing. Returned with TALER_EC_GENERIC_HTTP_HEADERS_MALFORMED.

403 Forbidden:

Two cases: - The signature is invalid. Returned with a code of

TALER_EC_EXCHANGE_GENERIC_AML_OFFICER_GET_SIGNATURE_INVALID.

  • The specific officer is unknown or disabled. Returned with a code of TALER_EC_EXCHANGE_GENERIC_AML_OFFICER_ACCESS_DENIED.

500 Internal server error:

The server had an internal problem handling the request. The error code is usually a TALER_EC_GENERIC_DB_FETCH_FAILED.

Details:

interface LegitimizationMeasuresListResponse {

  // Legitimization measures.
  measures: LegitimizationMeasureDetails[];

}

interface LegitimizationMeasureDetails {

  // Hash of the normalized payto:// URI of the account the
  // measure applies to.
  h_payto: HashCode;

  // Row of the measure in the exchange database.
  rowid: Integer;

  // When was the measure started?
  start_time: Timestamp;

  // The the actual measures.
  measures: LegitimizationMeasures;

  // Was this measure finished by the customer?
  is_finished: boolean;

}
Contents