API reference

identification.refused

Sent when an identify request is refused: an expired or revoked key, an origin that is not allowed, billing, rate limiting or no credit.

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

Sent for each identify request Fingerly refuses for a reason you can fix. Visitors whose requests are refused are not identified, so this is the event to alert on.

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.refused.
  • 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 refusal.
    5 child fields
    • request_idstring
      An ID for the refused request.
    • sdk_key_idstring
      The key that was used.
    • reasonstring
      Why it was refused. See below.
    • statusinteger
      The HTTP status the client received.
    • retry_after_secondsinteger
      For rate_limited: seconds until the client may retry. Omitted otherwise.

Reasons

`reason``status`What to do
expired_key401Issue a new key and deploy it.
revoked_key401A revoked key is still in use somewhere. Deploy its replacement.
origin_not_allowed401Add the site to the key's allowed origins, or find who is using your key.
billing_blocked402Resolve billing in the dashboard.
no_credit402Add funds, or turn on auto top-up.
rate_limited429Traffic exceeded your rate limit. Contact support if it is expected.