diff options
Diffstat (limited to 'core/api-auditor.rst')
| -rw-r--r-- | core/api-auditor.rst | 2478 |
1 files changed, 2423 insertions, 55 deletions
diff --git a/core/api-auditor.rst b/core/api-auditor.rst index cd0071e5..932da735 100644 --- a/core/api-auditor.rst +++ b/core/api-auditor.rst @@ -24,6 +24,25 @@ for all details not specified in the individual requests. The `glossary <https://docs.taler.net/glossary.html#glossary>`_ defines all specific terms used in this section. +.. contents:: Table of Contents + :local: + +.. _authentication: + +-------------- +Authentication +-------------- + +Each auditor instance has separate authentication settings for the private API resources +of that instance. + +Currently, the API supports two main authentication methods: + +* ``external``: With this method, no checks are done by the auditor backend. + Instead, a reverse proxy / API gateway must do all authentication/authorization checks. +* ``token``: With this method, the client must provide a ``Authorization: Bearer $TOKEN`` + header, where ``$TOKEN`` is a secret authentication token configured for the instance which must begin with the RFC 8959 prefix. + .. _auditor-version: ------------------------- @@ -34,9 +53,10 @@ This API is used by merchants to obtain a list of all exchanges audited by this auditor. This may be required for the merchant to perform the required know-your-customer (KYC) registration before issuing contracts. -.. http:get:: /version +.. http:get:: /config Get the protocol version and some meta data about the auditor. + This specification corresponds to ``current`` protocol being version **1**. **Response:** @@ -56,11 +76,19 @@ know-your-customer (KYC) registration before issuing contracts. // protocol is versioned independently of the exchange's protocol. version: string; + // URN of the implementation (needed to interpret 'revision' in version). + // @since v0, may become mandatory in the future. + implementation?: string; + // Return which currency this auditor is auditing for. currency: string; // EdDSA master public key of the auditor. auditor_public_key: EddsaPublicKey; + + // EdDSA master public key of the exchange. + // Added in protocol v1. + exchange_master_public_key: EddsaPublicKey; } .. note:: @@ -69,58 +97,11 @@ know-your-customer (KYC) registration before issuing contracts. time of this writing). -.. _exchange-list: - ------------------------ -Obtaining Exchange List ------------------------ - -This API is used by merchants to obtain a list of all exchanges audited by -this auditor. This may be required for the merchant to perform the required -know-your-customer (KYC) registration before issuing contracts. - -.. http:get:: /exchanges - - Get a list of all exchanges audited by the auditor. - - **Response:** - - :http:statuscode:`200 OK`: - The auditor responds with a :ts:type:`ExchangeList` object. This request should - virtually always be successful. - - **Details:** - - .. ts:def:: ExchangeList - - interface ExchangeList { - // Exchanges audited by this auditor. - exchanges: ExchangeEntry[]; - } - - .. ts:def:: ExchangeEntry - - interface ExchangeEntry { - - // Master public key of the exchange. - master_pub: EddsaPublicKey; - - // Base URL of the exchange. - exchange_url: string; - } - - .. note:: - - This API is still experimental (and is not yet implemented at the - time of this writing). A key open question is whether the auditor - should sign the information. We might also want to support more - delta downloads in the future. - .. _deposit-confirmation: --------------------------------- -Submitting deposit confirmations --------------------------------- +--------------------- +Deposit Confirmations +--------------------- Merchants should probabilistically submit some of the deposit confirmations they receive from the exchange to auditors to ensure @@ -162,6 +143,9 @@ paid out first. // Hash over the contract for which this deposit is made. h_contract_terms: HashCode; + // Hash over the extensions. + h_extensions: HashCode; + // Hash over the wiring information of the merchant. h_wire: HashCode; @@ -172,14 +156,19 @@ paid out first. // request? Zero if refunds are not allowed. refund_deadline: Timestamp; + // By what time does the exchange have to wire the funds? + wire_deadline: Timestamp; + // Amount to be deposited, excluding fee. Calculated from the // amount with fee and the fee from the deposit request. amount_without_fee: Amount; - // The coin's public key. This is the value that must have been - // signed (blindly) by the Exchange. The deposit request is to be - // signed by the corresponding private key (using EdDSA). - coin_pub: CoinPublicKey; + // Array of public keys of the deposited coins. + coin_pubs: EddsaPublicKey[]; + + // Array of deposit signatures of the deposited coins. + // Must have the same length as ``coin_pubs``. + coin_sigs: EddsaSignature[]; // The Merchant's public key. Allows the merchant to later refund // the transaction or to inquire about the wire transfer identifier. @@ -194,6 +183,7 @@ paid out first. // Master public key of the exchange corresponding to ``master_sig``. // Identifies the exchange this is about. + // @deprecated since v1 (now ignored, global per auditor) master_pub: EddsaPublicKey; // When does the validity of the exchange_pub end? @@ -216,6 +206,2384 @@ paid out first. should sign the response information. +.. _spa-api: + +--------------------------- +Single Page Application API +--------------------------- + +The following entries specify how to access the results of an audit. + +For most endpoints, rows may be marked as 'suppressed', to not send them again upon subsequent GET requests. +To do this, a :ts:type:`GenericUpdate` object may be used. + +**Details:** + + .. ts:def:: GenericUpdate + + interface GenericUpdate { + + // the row_id of a respective table that should be changed + row_id : Integer; + + // if true, subsequent GET requests will not, by default, receive the row specified in row_id. + suppressed : boolean; + + // unused + ancient? : boolean; + + } + + + +.. fee-time-inconsistency-list: + +Fee Time Inconsistencies +------------------------ + +This API is used to obtain a list of fee time inconsistencies + +.. http:get:: /fee-time-inconsistency + + Get a list of fee time inconsistencies stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`FeeTimeInconsistency` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: FeeTimeInconsistency + + interface FeeTimeInconsistency { + + + row_id : Integer; + + type : string; + + time : Timestamp; + + diagnostic : string; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of fee time inconsistencies + +.. http:patch:: /fee-time-inconsistency + + Update the 'suppressed' field of an fee time inconsistency element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. emergency-by-count-list: + +Emergencies By Count +-------------------- + +This API is used to obtain a list of emergencies by count + +.. http:get:: /emergency-by-count + + Get a list of emergencies by count stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`EmergencyByCount` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: EmergencyByCount + + interface EmergencyByCount { + + + row_id : Integer; + + denompub_h : HashCode; + + num_issued : Integer; + + num_known : Integer; + + risk : Amount; + + start : Timestamp; + + deposit_end : Timestamp; + + value : Amount; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of emergencies by count + +.. http:patch:: /emergency-by-count + + Update the 'suppressed' field of an emergency by count element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. row-inconsistency-list: + +Row Inconsistencies +------------------- + +This API is used to obtain a list of row inconsistencies + +.. http:get:: /row-inconsistency + + Get a list of row inconsistencies stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`RowInconsistency` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: RowInconsistency + + interface RowInconsistency { + + + row_id : Integer; + + row_table : string; + + diagnostic : string; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of row inconsistencies + +.. http:patch:: /row-inconsistency + + Update the 'suppressed' field of an row inconsistency element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. reserve-in-inconsistency-list: + +Reserve In Inconsistencies +-------------------------- + +This API is used to obtain a list of reserve in inconsistencies + +.. http:get:: /reserve-in-inconsistency + + Get a list of reserve in inconsistencies stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`ReserveInInconsistency` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: ReserveInInconsistency + + interface ReserveInInconsistency { + + + row_id : Integer; + + amount_exchange_expected : Amount; + + amount_wired : Amount; + + reserve_pub : EddsaPublicKey; + + timestamp : Timestamp; + + account : string; + + diagnostic : string; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of reserve in inconsistencies + +.. http:patch:: /reserve-in-inconsistency + + Update the 'suppressed' field of an reserve in inconsistency element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. purse-not-closed-inconsistencies-list: + +Purse Not Closed Inconsistencies +-------------------------------- + +This API is used to obtain a list of purse not closed inconsistencies + +.. http:get:: /purse-not-closed-inconsistencies + + Get a list of purse not closed inconsistencies stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`PurseNotClosedInconsistencies` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: PurseNotClosedInconsistencies + + interface PurseNotClosedInconsistencies { + + + row_id : Integer; + + purse_pub : EddsaPublicKey; + + amount : Amount; + + expiration_date : Timestamp; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of purse not closed inconsistencies + +.. http:patch:: /purse-not-closed-inconsistencies + + Update the 'suppressed' field of an purse not closed inconsistencies element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. reserve-not-closed-inconsistency-list: + +Reserve Not Closed Inconsistencies +---------------------------------- + +This API is used to obtain a list of reserve not closed inconsistencies + +.. http:get:: /reserve-not-closed-inconsistency + + Get a list of reserve not closed inconsistencies stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`ReserveNotClosedInconsistency` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: ReserveNotClosedInconsistency + + interface ReserveNotClosedInconsistency { + + + row_id : Integer; + + reserve_pub : EddsaPublicKey; + + balance : Amount; + + expiration_time : Timestamp; + + diagnostic : string; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of reserve not closed inconsistencies + +.. http:patch:: /reserve-not-closed-inconsistency + + Update the 'suppressed' field of an reserve not closed inconsistency element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. reserve-balance-insufficient-inconsistency-list: + +Reserve Balance Insufficient Inconsistencies +-------------------------------------------- + +This API is used to obtain a list of reserve balance insufficient inconsistencies + +.. http:get:: /reserve-balance-insufficient-inconsistency + + Get a list of reserve balance insufficient inconsistencies stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`ReserveBalanceInsufficientInconsistency` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: ReserveBalanceInsufficientInconsistency + + interface ReserveBalanceInsufficientInconsistency { + + + row_id : Integer; + + reserve_pub : EddsaPublicKey; + + inconsistency_gain : boolean; + + inconsistency_amount : Amount; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of reserve balance insufficient inconsistencies + +.. http:patch:: /reserve-balance-insufficient-inconsistency + + Update the 'suppressed' field of an reserve balance insufficient inconsistency element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. bad-sig-losses-list: + +Bad Sig Losses +-------------- + +This API is used to obtain a list of bad sig losses + +.. http:get:: /bad-sig-losses + + Get a list of bad sig losses stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + :query operation: A string. If specified, only returns eligible rows with this :ts:type:`BadSigLosses`.operation value. The default value is NULL. + :query use_op_spec_pub: A boolean. If true, use the value of :ts:type:`OpSpecPub` to only return eligible rows with this :ts:type:`BadSigLosses`.operation_specific_pub value. The default value is NULL. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`BadSigLosses` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: BadSigLosses + + interface BadSigLosses { + + + row_id : Integer; + + operation : string; + + loss : Amount; + + operation_specific_pub : EddsaPublicKey; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of bad sig losses + +.. http:patch:: /bad-sig-losses + + Update the 'suppressed' field of an bad sig losses element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. coin-inconsistency-list: + +Coin Inconsistencies +-------------------- + +This API is used to obtain a list of coin inconsistencies + +.. http:get:: /coin-inconsistency + + Get a list of coin inconsistencies stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`CoinInconsistency` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: CoinInconsistency + + interface CoinInconsistency { + + + row_id : Integer; + + operation : string; + + exchange_amount : Amount; + + auditor_amount : Amount; + + coin_pub : EddsaPublicKey; + + profitable : boolean; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of coin inconsistencies + +.. http:patch:: /coin-inconsistency + + Update the 'suppressed' field of an coin inconsistency element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. balances-list: + +Balances +-------- + +This API is used to obtain a list of balances + +.. http:get:: /balances + + Get a list of balances stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + :query balance_key: a string identifying a balance. If specified, only returns elements with this exact key. The default value is NULL. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`Balances` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: Balances + + interface Balances { + + + row_id : Integer; + + balance_key : string; + + balance_value : Amount; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of balances + +.. http:patch:: /balances + + Update the 'suppressed' field of an balances element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. denominations-without-sigs-list: + +Denominations Without Sigs +-------------------------- + +This API is used to obtain a list of denominations without sigs + +.. http:get:: /denominations-without-sigs + + Get a list of denominations without sigs stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`DenominationsWithoutSigs` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: DenominationsWithoutSigs + + interface DenominationsWithoutSigs { + + + row_id : Integer; + + denompub_h : HashCode; + + value : Amount; + + start_time : Timestamp; + + end_time : Timestamp; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of denominations without sigs + +.. http:patch:: /denominations-without-sigs + + Update the 'suppressed' field of an denominations without sigs element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. misattribution-in-inconsistency-list: + +Misattribution In Inconsistencies +--------------------------------- + +This API is used to obtain a list of misattribution in inconsistencies + +.. http:get:: /misattribution-in-inconsistency + + Get a list of misattribution in inconsistencies stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`MisattributionInInconsistency` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: MisattributionInInconsistency + + interface MisattributionInInconsistency { + + + row_id : Integer; + + amount : Amount; + + bank_row : Integer; + + reserve_pub : EddsaPublicKey; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of misattribution in inconsistencies + +.. http:patch:: /misattribution-in-inconsistency + + Update the 'suppressed' field of an misattribution in inconsistency element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. progress-list: + +Progress +-------- + +This API is used to obtain a list of progress + +.. http:get:: /progress + + Get a list of progress stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`Progress` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: Progress + + interface Progress { + + + progress_key : string; + + progress_offset : Integer; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of progress + +.. http:patch:: /progress + + Update the 'suppressed' field of an progress element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. reserves-list: + +Reserves +-------- + +This API is used to obtain a list of reserves + +.. http:get:: /reserves + + Get a list of reserves stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`Reserves` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: Reserves + + interface Reserves { + + + auditor_reserves_rowid : Integer; + + reserve_pub : EddsaPublicKey; + + reserve_balance : Amount; + + reserve_loss : Amount; + + withdraw_fee_balance : Amount; + + close_fee_balance : Amount; + + purse_fee_balance : Amount; + + open_fee_balance : Amount; + + history_fee_balance : Amount; + + expiration_date : Timestamp; + + origin_account : string; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of reserves + +.. http:patch:: /reserves + + Update the 'suppressed' field of an reserves element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. deposit-confirmations-list: + +Deposit Confirmations +--------------------- + +This API is used to obtain a list of deposit confirmations + +.. http:get:: /deposit-confirmations + + Get a list of deposit confirmations stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`DepositConfirmations` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: DepositConfirmations + + interface DepositConfirmations { + + + deposit_confirmation_serial_id : Integer; + + h_contract_terms : HashCode; + + h_policy : HashCode; + + h_wire : HashCode; + + exchange_timestamp : Timestamp; + + refund_deadline : Timestamp; + + wire_deadline : Timestamp; + + total_without_fee : Amount; + + coin_pubs : EddsaPublicKey; + + coin_sigs : EddsaSignature; + + merchant_pub : EddsaPublicKey; + + exchange_sig : EddsaSignature; + + exchange_pub : EddsaPublicKey; + + master_sig : EddsaSignature; + + suppressed : boolean; + + ancient : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of deposit confirmations + +.. http:patch:: /deposit-confirmations + + Update the 'suppressed' field of an deposit confirmations element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used by the auditor to delete an audited deposit confirmation. + +.. http:delete:: /deposit-confirmation/$SERIAL_ID + + Delete deposit confirmation entry with given serial_id. + + **Response:** + + :http:statuscode:`204 No content`: + The deposit confirmation was deleted. + + :http:statuscode:`401 Unauthorized`: + Unauthorized request. + + :http:statuscode:`404 Not found`: + The deposit confirmation was unknown. + + .. note:: + + This API is still experimental (and is not yet implemented at the + time of this writing). + + +.. denomination-key-validity-withdraw-inconsistency-list: + +Denomination Key Validity Withdraw Inconsistencies +-------------------------------------------------- + +This API is used to obtain a list of denomination key validity withdraw inconsistencies + +.. http:get:: /denomination-key-validity-withdraw-inconsistency + + Get a list of denomination key validity withdraw inconsistencies stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`DenominationKeyValidityWithdrawInconsistency` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: DenominationKeyValidityWithdrawInconsistency + + interface DenominationKeyValidityWithdrawInconsistency { + + + row_id : Integer; + + execution_date : Timestamp; + + reserve_pub : EddsaPublicKey; + + denompub_h : HashCode; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of denomination key validity withdraw inconsistencies + +.. http:patch:: /denomination-key-validity-withdraw-inconsistency + + Update the 'suppressed' field of an denomination key validity withdraw inconsistency element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. purses-list: + +Purses +------ + +This API is used to obtain a list of purses + +.. http:get:: /purses + + Get a list of purses stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`Purses` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: Purses + + interface Purses { + + + auditor_purses_rowid : Integer; + + purse_pub : EddsaPublicKey; + + balance : Amount; + + target : Amount; + + expiration_date : Timestamp; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of purses + +.. http:patch:: /purses + + Update the 'suppressed' field of an purses element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. amount-arithmetic-inconsistency-list: + +Amount Arithmetic Inconsistencies +--------------------------------- + +This API is used to obtain a list of amount arithmetic inconsistencies + +.. http:get:: /amount-arithmetic-inconsistency + + Get a list of amount arithmetic inconsistencies stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`AmountArithmeticInconsistency` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: AmountArithmeticInconsistency + + interface AmountArithmeticInconsistency { + + + row_id : Integer; + + operation : string; + + exchange_amount : Amount; + + auditor_amount : Amount; + + profitable : boolean; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of amount arithmetic inconsistencies + +.. http:patch:: /amount-arithmetic-inconsistency + + Update the 'suppressed' field of an amount arithmetic inconsistency element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. historic-denomination-revenue-list: + +Historic Denomination Revenue +----------------------------- + +This API is used to obtain a list of historic denomination revenue + +.. http:get:: /historic-denomination-revenue + + Get a list of historic denomination revenue stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`HistoricDenominationRevenue` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: HistoricDenominationRevenue + + interface HistoricDenominationRevenue { + + + denom_pub_hash : HashCode; + + revenue_timestamp : Timestamp; + + revenue_balance : Amount; + + loss_balance : Amount; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of historic denomination revenue + +.. http:patch:: /historic-denomination-revenue + + Update the 'suppressed' field of an historic denomination revenue element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. denomination-pending-list: + +Denomination Pending +-------------------- + +This API is used to obtain a list of denomination pending + +.. http:get:: /denomination-pending + + Get a list of denomination pending stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`DenominationPending` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: DenominationPending + + interface DenominationPending { + + + denom_pub_hash : HashCode; + + denom_balance : Amount; + + denom_loss : Amount; + + num_issued : Integer; + + denom_risk : Amount; + + recoup_loss : Amount; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of denomination pending + +.. http:patch:: /denomination-pending + + Update the 'suppressed' field of an denomination pending element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. historic-reserve-summary-list: + +Historic Reserve Summary +------------------------ + +This API is used to obtain a list of historic reserve summary + +.. http:get:: /historic-reserve-summary + + Get a list of historic reserve summary stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`HistoricReserveSummary` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: HistoricReserveSummary + + interface HistoricReserveSummary { + + + row_id : Integer; + + start_date : Timestamp; + + end_date : Timestamp; + + reserve_profits : Amount; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of historic reserve summary + +.. http:patch:: /historic-reserve-summary + + Update the 'suppressed' field of an historic reserve summary element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. exchange-signkeys-list: + +Exchange Signkeys +----------------- + +This API is used to obtain a list of exchange signkeys + +.. http:get:: /exchange-signkeys + + Get a list of exchange signkeys stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`ExchangeSignkeys` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: ExchangeSignkeys + + interface ExchangeSignkeys { + + + exchange_pub : EddsaPublicKey; + + master_sig : EddsaSignature; + + ep_valid_from : Timestamp; + + ep_expire_sign : Timestamp; + + ep_expire_legal : Timestamp; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of exchange signkeys + +.. http:patch:: /exchange-signkeys + + Update the 'suppressed' field of an exchange signkeys element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. wire-format-inconsistency-list: + +Wire Format Inconsistencies +--------------------------- + +This API is used to obtain a list of wire format inconsistencies + +.. http:get:: /wire-format-inconsistency + + Get a list of wire format inconsistencies stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`WireFormatInconsistency` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: WireFormatInconsistency + + interface WireFormatInconsistency { + + + row_id : Integer; + + amount : Amount; + + wire_offset : Integer; + + diagnostic : string; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of wire format inconsistencies + +.. http:patch:: /wire-format-inconsistency + + Update the 'suppressed' field of an wire format inconsistency element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. refreshes-hanging-list: + +Refreshes Hanging +----------------- + +This API is used to obtain a list of refreshes hanging + +.. http:get:: /refreshes-hanging + + Get a list of refreshes hanging stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`RefreshesHanging` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: RefreshesHanging + + interface RefreshesHanging { + + + row_id : Integer; + + amount : Amount; + + coin_pub : EddsaPublicKey; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of refreshes hanging + +.. http:patch:: /refreshes-hanging + + Update the 'suppressed' field of an refreshes hanging element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. emergency-list: + +Emergencies +----------- + +This API is used to obtain a list of emergencies + +.. http:get:: /emergency + + Get a list of emergencies stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`Emergency` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: Emergency + + interface Emergency { + + + row_id : Integer; + + denompub_h : HashCode; + + denom_risk : Amount; + + denom_loss : Amount; + + deposit_start : Timestamp; + + deposit_end : Timestamp; + + value : Amount; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of emergencies + +.. http:patch:: /emergency + + Update the 'suppressed' field of an emergency element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. closure-lags-list: + +Closure Lags +------------ + +This API is used to obtain a list of closure lags + +.. http:get:: /closure-lags + + Get a list of closure lags stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`ClosureLags` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: ClosureLags + + interface ClosureLags { + + + row_id : Integer; + + amount : Amount; + + deadline : Timestamp; + + wtid : Integer; + + account : string; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of closure lags + +.. http:patch:: /closure-lags + + Update the 'suppressed' field of an closure lags element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. wire-out-inconsistency-list: + +Wire Out Inconsistencies +------------------------ + +This API is used to obtain a list of wire out inconsistencies + +.. http:get:: /wire-out-inconsistency + + Get a list of wire out inconsistencies stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`WireOutInconsistency` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: WireOutInconsistency + + interface WireOutInconsistency { + + + row_id : Integer; + + destination_account : string; + + expected : Amount; + + claimed : Amount; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of wire out inconsistencies + +.. http:patch:: /wire-out-inconsistency + + Update the 'suppressed' field of an wire out inconsistency element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. reserve-balance-summary-wrong-inconsistency-list: + +Reserve Balance Summary Wrong Inconsistencies +--------------------------------------------- + +This API is used to obtain a list of reserve balance summary wrong inconsistencies + +.. http:get:: /reserve-balance-summary-wrong-inconsistency + + Get a list of reserve balance summary wrong inconsistencies stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`ReserveBalanceSummaryWrongInconsistency` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: ReserveBalanceSummaryWrongInconsistency + + interface ReserveBalanceSummaryWrongInconsistency { + + + row_id : Integer; + + reserve_pub : EddsaPublicKey; + + exchange_amount : Amount; + + auditor_amount : Amount; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of reserve balance summary wrong inconsistencies + +.. http:patch:: /reserve-balance-summary-wrong-inconsistency + + Update the 'suppressed' field of an reserve balance summary wrong inconsistency element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +.. row-minor-inconsistencies-list: + +Row Minor Inconsistencies +------------------------- + +This API is used to obtain a list of row minor inconsistencies + +.. http:get:: /row-minor-inconsistencies + + Get a list of row minor inconsistencies stored by the auditor. + + The following query parameters are optional, and can be used to customise the response: + + **Request:** + + :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. + :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. + :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. + + + The default values, thus, return at max the 20 latest elements that are not suppressed. + + **Response:** + + :http:statuscode:`200 OK`: + The auditor responds with a top level array of :ts:type:`RowMinorInconsistencies` objecs. + + :http:statuscode:`403 Forbidden`: + No or bad Bearer token provided. + + :http:statuscode:`404 Not Found`: + No elements could be found. + + **Details:** + + .. ts:def:: RowMinorInconsistencies + + interface RowMinorInconsistencies { + + + row_id : Integer; + + row_table : Integer; + + diagnostic : string; + + suppressed : boolean; + + + } + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + +This API is used to suppress select elements of row minor inconsistencies + +.. http:patch:: /row-minor-inconsistencies + + Update the 'suppressed' field of an row minor inconsistencies element according to :ts:type:`GenericUpdate`, stored by the auditor. + + **Response:** + + :http:statuscode:`202 Accepted`: + The element has been accepted for processing. + + .. note:: + + This API is still experimental. The API will be further developed as needed. + + + + ---------- Complaints ---------- |