FIB Documentation

Appearance

Orillion logo
Soramitsu logo

Retrieving top contributions ​

Note

A peer account must be authorized for this operation to succeed. See Authorizing an account.

When downloading fraud events—retrieving contributions—it is possible to filter the results generated in the response in various ways, using the request parameters.

Request parameters can be used in any combination to tailor response results to your specific needs.

Since request parameters are optional, specifying no parameters when sending a request will result in a response containing top contributions from the entire ledger.

For more information, see Retrieving top contributions > Parameters.

To retrieve top contributions, send the following request:

http
GET /api/v1/contribution-management/contribution?size=''&from=''&to=''&ft=''&org=''&self-only=''
GET /api/v1/contribution-management/contribution?size=''&from=''&to=''&ft=''&org=''&self-only=''
http
// size
/api/v1/contribution-management/contribution?size=10

// from & to
/api/v1/contribution-management/contribution?from=0&to=1680089219

// ft
/api/v1/contribution-management/contribution?ft=wangiri

// org
/api/v1/contribution-management/contribution?org=US

// self-only
/api/v1/contribution-management/contribution?self-only=true

// fetch-mode
/api/v1/contribution-management/contribution?fetch-mode=new

// combination
/api/v1/contribution-management/contribution?size=2&ft=StolenDevice&org=US&self-only=true&fetch-mode=new
// size
/api/v1/contribution-management/contribution?size=10

// from & to
/api/v1/contribution-management/contribution?from=0&to=1680089219

// ft
/api/v1/contribution-management/contribution?ft=wangiri

// org
/api/v1/contribution-management/contribution?org=US

// self-only
/api/v1/contribution-management/contribution?self-only=true

// fetch-mode
/api/v1/contribution-management/contribution?fetch-mode=new

// combination
/api/v1/contribution-management/contribution?size=2&ft=StolenDevice&org=US&self-only=true&fetch-mode=new

Expected result ​

The response to the GET request contains a list of the top contributions, filtered according to the parameters set in the request, if any.

json5
{
  status: {
    code: 0, //integer($int32)
    name: 'string',
    message: 'string'
  },
  data: [
    {
      id: 'string',
      fraudType: 'Wangiri', //Could be one of the following: Wangiri, IRSF, StolenDevice, IPFraud, SMSA2P
      origination: 'string',
      destination: 'string',
      expiryDate: 0, //integer($int32)
      fraudStatus: 'string(enum)', //Could be one of the following: Active, Expired, Flagged
      confidenceIndex: 0, //number($double)
      isPremium: true, //boolean
      peerId: 'string',
      premium: true //boolean
    }
  ]
}
{
  status: {
    code: 0, //integer($int32)
    name: 'string',
    message: 'string'
  },
  data: [
    {
      id: 'string',
      fraudType: 'Wangiri', //Could be one of the following: Wangiri, IRSF, StolenDevice, IPFraud, SMSA2P
      origination: 'string',
      destination: 'string',
      expiryDate: 0, //integer($int32)
      fraudStatus: 'string(enum)', //Could be one of the following: Active, Expired, Flagged
      confidenceIndex: 0, //number($double)
      isPremium: true, //boolean
      peerId: 'string',
      premium: true //boolean
    }
  ]
}
json5
{
  status: {
    code: 0,
    name: 'Ok'
  },
  data: [
    {
      id: '+14155552671-+14155552981',
      fraudType: 'StolenDevice',
      origination: 'US',
      destination: 'FI',
      expiryDate: 1666195955,
      fraudStatus: 'Expired',
      confidenceIndex: null,
      isPremium: true,
      peerId: 'string',
      premium: false
    },
    {
      id: '127.0.0.1-127.0.0.2',
      fraudType: 'StolenDevice',
      origination: 'US',
      destination: 'SE',
      expiryDate: 1694775553,
      fraudStatus: 'Flagged',
      confidenceIndex: null,
      isPremium: true,
      peerId: 'string',
      premium: false
    }
  ]
}
{
  status: {
    code: 0,
    name: 'Ok'
  },
  data: [
    {
      id: '+14155552671-+14155552981',
      fraudType: 'StolenDevice',
      origination: 'US',
      destination: 'FI',
      expiryDate: 1666195955,
      fraudStatus: 'Expired',
      confidenceIndex: null,
      isPremium: true,
      peerId: 'string',
      premium: false
    },
    {
      id: '127.0.0.1-127.0.0.2',
      fraudType: 'StolenDevice',
      origination: 'US',
      destination: 'SE',
      expiryDate: 1694775553,
      fraudStatus: 'Flagged',
      confidenceIndex: null,
      isPremium: true,
      peerId: 'string',
      premium: false
    }
  ]
}