fingerlydocs
fingerly.io Log inDashboard
API reference

identification.completed

Sent for every identification that finishes, with the visitor, the confidence, the score and your tag.

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

Sent once for every identification your SDKs complete, whatever its score. Use it to keep your own copy of results, or to act on visitors without polling.

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 identification.completed.
  • 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 identification.
    11 child fields
    • request_idstring
      The identification's request ID.
    • sdk_key_idstring
      The public key that submitted it.
    • visitor_idstring
      The visitor.
    • visitor_is_newboolean
      Whether the visitor is new to your organization.
    • identifiableboolean
      Whether the device could be identified.
    • confidenceinteger
      The visitor confidence, 0 to 100.
    • statestring
      enriched or unavailable.
    • reasonstring
      Why the state is unavailable. Empty otherwise.
    • scoreinteger | null
      The suspect score. null when not scored.
    • levelstring | null
      low, medium or high. null when not scored.
    • tagstring
      Your tag. Empty when none was sent.

The signals behind the score are not repeated here. Read them with Get an event, or subscribe to visitor.suspect, which includes them.

Last updated