fingerlydocs
fingerly.io Log inDashboard
API reference

Risk weights

Read, save and restore suspect-score weights and thresholds for your organization and for individual SDK keys, and list the signals they apply to.

Risk weights decide what each signal adds to the suspect score, and the threshold decides where high begins. Keep them in version control and apply them from code. See risk weights for how profiles are chosen. Any management key can read weights; only admin keys can change them.

Path parameters

  • organization_idstringrequired
    Your organization, from Describe the key. A path naming any other organization answers 404.
  • platformstring
    web, android or ios, where a path has it.
  • sdk_key_idstring
    The SDK key, where a path has it.

List signals

GET/api/v1/management/signals/catalogue Management key

Every signal group and the signals in it, with the platforms each applies to and its default weights, the default threshold and the maximum weight. The same for every organization. Weights are set against the signal names listed here.

Read the organization's weights

GET/api/v1/management/organizations/{organization_id}/risk-weights Management key

Response

  • scopestring
    organization.
  • max_weightinteger
    The largest weight accepted, 10000.
  • platformsPlatformWeights[]
    One entry per platform.
    11 child fields
    • platformstring
      web, android or ios.
    • scopestring
      organization, or default when nothing has been saved.
    • storedboolean
      Whether this scope has its own saved configuration.
    • revisioninteger
      Send it back to detect concurrent edits.
    • suspect_thresholdinteger
      The threshold.
    • weightsobject
      Signal name to weight.
    • defaultsobject
      The shipped default for each signal.
    • signalsstring[]
      The signals this platform can weight.
    • vpn_weights_modestring
      method or confidence.
    • residential_proxy_weights_modestring
      method or confidence.
    • updated_atstring
      When the configuration was last saved.

Save the organization's weights

PUT/api/v1/management/organizations/{organization_id}/risk-weights/{platform} Management key

Body

  • weightsobject
    Signal name to weight, from 0 to 10000. Replaces the stored weights. A signal left out uses its default; 0 turns it off.
  • suspect_thresholdinteger
    The score at which the level becomes high, from 1 to 1000000.
  • vpn_weights_modestring
    method or confidence.
  • residential_proxy_weights_modestring
    method or confidence.
  • revisioninteger
    The revision a read returned. The save is refused with 409 and weights_stale if the weights changed since. Omit it to overwrite.

Every field is optional. Answers with the platform's configuration, which scores the next identification.

Restore the default weights

DELETE/api/v1/management/organizations/{organization_id}/risk-weights/{platform} Management key

Saves the shipped defaults for the platform and answers with them.

Read an SDK key's weights

GET/api/v1/management/organizations/{organization_id}/sdk-keys/{sdk_key_id}/risk-weights Management key

The same shape as the organization's, with scope set to key. A platform the key has not overridden answers with the organization's values and stored set to false.

Save an SDK key's weights

PUT/api/v1/management/organizations/{organization_id}/sdk-keys/{sdk_key_id}/risk-weights/{platform} Management key

Body

  • weightsobject
    Signal name to weight, from 0 to 10000. Replaces the stored weights. A signal left out uses its default; 0 turns it off.
  • suspect_thresholdinteger
    The score at which the level becomes high, from 1 to 1000000.
  • vpn_weights_modestring
    method or confidence.
  • residential_proxy_weights_modestring
    method or confidence.
  • revisioninteger
    The revision a read returned. The save is refused with 409 and weights_stale if the weights changed since. Omit it to overwrite.

Overrides the organization's profile for this key alone. Because a key belongs to one environment, this is how a new policy is tried on staging keys before it reaches production.

Remove an SDK key's weights

DELETE/api/v1/management/organizations/{organization_id}/sdk-keys/{sdk_key_id}/risk-weights/{platform} Management key

Deletes the key's own configuration, so the key follows the organization's profile again, and answers with what the key is scored under now.

Last updated