API reference

Submit a deferred report

Attach the signals an SDK collects after its initial budget to an identification that has already been answered.

POST/api/v1/events/{request_id}/supplement Public key

Some signals take longer to read than the initial collection budget allows. The browser SDK sends them afterwards with this endpoint. A deferred report is archived with the event and returned as deferred_signals by Get an event. It never changes the visitor ID, the score, billing or webhooks.

Path parameters

  • request_idstringrequired
    The request_id from the identify response.

Body

  • tokenstringrequired
    The deferred_token from the identify response. Valid for 24 hours, for the same key and origin.
  • sdkobjectrequired
    The SDK's platform and version.
  • signalsobjectrequired
    The deferred-tier report. Produced by the SDK.

Response

202 Accepted:

  • request_idstring
    The request the report was attached to.
  • duplicateboolean
    true when this exact report was already accepted. Omitted otherwise.

Deferred reports are free.

Errors

StatusCodeWhen
409supplement_conflictA different report was already accepted for this request.
422invalid_supplementThe token is invalid, expired or for another request, or the report is not a deferred report.
422invalid_request_idThe path is not a Fingerly request ID.
503service_unavailableThe report could not be accepted just now.