Contributions
Contribution — a piece of data that describes a fraud event on the blockchain.
Contributions can be submitted by authorized peers, and are stored on the blockchain.
A peer that has contributed at least a single fraud event is considered a contributor.
Operations
Submitting contributions
Once a contribution has been submitted, the peer’s list of contributions is updated, and their credit balance is increased by an amount equal to the number of contributions submitted based on the current reward rate active in the network.
For complete instructions on how to submit a contribution, see Submitting a contribution.
For information on the credit balance and rewards, see Tokenomics.
Retrieving contributions
In order for peers to keep their own records updated with the latest fraud event data, they can retrieve top contributions in a number of ways.
Flagging contributions
If a peer deems a certain contribution to no longer be relevant (e.g., it is a false positive), they can flag that contribution. Once a contribution is flagged, the ID of the peer that flagged it is saved with the contribution as flagger value.
API requests data structure
When retrieving top contributions, the following data is returned in the body of the response:
Response body
| Field | Value Type | Description |
|---|---|---|
id | string | Fraud event identifier. |
fraudType | enum string | The type of the fraud event. Could be one of the following:
|
origination | string | The two-digit code of the country the fraud event originated from (Alpha-2, ISO 3166). |
destination | string | The two-digit code of the country the fraud event was identified as such (Alpha-2, ISO 3166). |
expiryDate | integer($int32) | The exact time and date until which the event is considered relevant (represented as Unix Epoch time in seconds). |
fraudStatus | enum string | The status of the event at the time of observing. Could be one of the following:
|
confidenceIndex | number($double) | The predicted fraud likelihood score in the range from 1 to 100. |
isPremium | boolean | The definition of whether the contributor is a premium user. |
peerId | string | The unique ID of the peer that contributed the data. |
flagger | string | The unique ID of the peer that flagged the data. If a contribution hasn't been flagged at the time of observing, the field is returned empty. |
self | integer($int32) | Out of all the retrieved contributions, the number of contributions that have been submitted by the requesting user. |
old | integer($int32) | Out of all the retrieved contributions, the number of contributions that have already been seen by the requesting user. |
new | integer($int32) | Out of all the retrieved contributions, the number of contributions that have not yet been seen by the requesting user. |
creditsSpent | integer($int32) | The total amount of credits spent on the retrieved contributions. |
When assembling a contribution to then submit it, the following data must be specified in the body of the request:
Request body
| Field | Value Type | Description |
|---|---|---|
id | string | Fraud event identifier. |
fraudType | enum string | The type of the fraud event. Could be one of the following:
|
origination | string | The two-digit code of the country the fraud event originated from (Alpha-2, ISO 3166). |
destination | string | The two-digit code of the country the fraud event was identified as such (Alpha-2, ISO 3166). |
expiryDate | integer($int32) | The exact time and date until which the event is considered relevant (represented as Unix Epoch time in seconds). |