fingerlydocs
fingerly.io Log inDashboard
API reference

visitor.suspect

Sent when an identification reaches the high suspect level, with the score, your threshold and every signal behind it.

POSThttps://your-server.example.com/webhooks/fingerly Signed by Fingerly

Sent alongside identification.completed when an identification lands at the high level: its score reached the threshold in force when it was scored. Subscribe to this alone if you only act on high-risk visitors.

Body

  • idstring
    The event's ID, a UUIDv7. The same on every retry: deduplicate on it. Also sent as X-Fingerly-Event-ID.
  • typestring
    Always visitor.suspect.
  • versioninteger
    The envelope version, 1.
  • organization_idstring
    Your organization.
  • environmentstring
    live for production traffic, test for staging and development.
  • created_atstring
    When the underlying fact happened, RFC 3339 in UTC. Not when it was delivered.
  • dataobject
    The high-risk identification.
    8 child fields
    • request_idstring
      The identification's request ID.
    • sdk_key_idstring
      The public key that submitted it.
    • visitor_idstring
      The visitor.
    • scoreinteger
      The suspect score.
    • levelstring
      Always high.
    • thresholdinteger
      The threshold the score was compared with.
    • triggersarray
      Every signal that fired, heaviest first.
      4 child fields
      • signalstring
        The signal.
      • groupstring
        The signal's group.
      • weightinteger
        The weight it added.
      • confidencestring
        low, medium or high.
    • tagstring
      Your tag. Empty when none was sent.

Last updated