fingerlydocs
fingerly.io Log inDashboard
API reference

Get an event

Read one identification event by its request ID with a secret key. This is how your server verifies what a client reported.

GET/api/v1/events/{request_id} Secret key

Returns the stored event for a request ID, from the secret key's own organization and environment. Use it to verify an identification before you act on it.

Try it

Sends this request from your browser to Fingerly. Development secret keys only, and the key is not stored.

GET https://us.api.fingerly.io/api/v1/events/{request_id}

Path parameters

  • request_idstringrequired
    The request_id an SDK returned.

Response

  • request_idstring
    The identification's ID, a UUIDv7.
  • visitor_idstring
    The visitor the device was identified as.
  • occurred_atstring
    When the request arrived, RFC 3339 in UTC.
  • statestring
    enriched, or unavailable when the network lookup could not run.
  • environmentstring
    production, staging or development.
  • platformstring
    The scoring profile applied: web, android or ios.
  • sdk_platformstring
    The SDK that sent the report, such as web, ios or flutter-android.
  • sdk_versionstring
    The SDK's version.
  • originstring
    The site the request came from. Omitted for native apps.
  • tagstring
    Your tag, as sent. Omitted when none was sent.
  • ip_addressstring
    The visitor's IP address.
  • country_codestring
    ISO 3166-1 alpha-2 country of the address.
  • country_namestring
    The country's name.
  • asnstring
    The network's autonomous system number.
  • asn_namestring
    The network's name.
  • anonymity_networkstring
    tor, vpn, proxy or hosting. Omitted for an ordinary connection.
  • agentstring
    The browser or app.
  • agent_versionstring
    Its version.
  • osstring
    The operating system.
  • device_kindstring
    desktop, mobile, tablet or server.
  • visitor_kindstring
    human, ai_bot, automation or search_crawler.
  • suspect_scoreinteger | null
    The score. null when the request was not scored.
  • suspect_levelstring
    low, medium or high. Omitted when not scored.
  • triggersarray
    The signal groups that fired, heaviest first. Always present, possibly empty.
    3 child fields
    • signalstring
      The signal group, such as vpn or bot.
    • weightinteger
      The group's combined weight in this score.
    • confidencestring
      low, medium or high.
  • has_documentboolean
    Whether the archived submission can be read with Get an event.

Archived detail

  • documentobject
    The archived submission as Fingerly stored it, including the scoring details: the threshold and weights profile applied. Present when has_document is true and the archive could be read.
  • deferred_signalsobject
    The deferred report attached to this request, when one arrived.

Errors

StatusCodeWhen
401unauthorizedThe key is not a valid secret key.
404event_not_foundNo such event in this environment, or it is older than 30 days.
422invalid_request_idThe path is not a Fingerly request ID.

Last updated