Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions schemas/fingerprint-related-visitors-api-readme-explorer.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ info:
> This version of Server API is marked as deprecated starting on **Jan 7th
2026** and will be fully defunct on **Jan 7th 2027** according to our [API
Deprecation
Policy](https://dev.fingerprint.com/reference/api-deprecation-policy). If
Policy](https://docs.fingerprint.com/reference/api-deprecation-policy). If
you still use this version, please follow our [migration
guide](https://dev.fingerprint.com/reference/migrating-from-server-api-v3-to-v4)
guide](https://docs.fingerprint.com/reference/migrating-from-server-api-v3-to-v4)
to migrate from this deprecated version to the new one.


Expand Down Expand Up @@ -51,7 +51,7 @@ paths:
> This version of Server API is marked as deprecated starting on **Jan
7th 2026** and will be fully removed on **Jan 7th 2027** according to
our [API Deprecation
Policy](https://dev.fingerprint.com/reference/api-deprecation-policy).
Policy](https://docs.fingerprint.com/reference/api-deprecation-policy).


Related visitors API lets you link web visits and in-app browser visits
Expand All @@ -70,7 +70,7 @@ paths:
[support team](https://fingerprint.com/support).

To learn more, see [Related visitors API
reference](https://dev.fingerprint.com/reference/related-visitors-api).
reference](https://docs.fingerprint.com/reference/related-visitors-api).
parameters:
- name: visitor_id
in: query
Expand All @@ -79,7 +79,7 @@ paths:
type: string
description: >-
The [visitor
ID](https://dev.fingerprint.com/reference/get-function#visitorid)
ID](https://docs.fingerprint.com/reference/v3/js-agent-get-function#visitorid)
for which you want to find the other visitor IDs that originated
from the same mobile device.
responses:
Expand Down
76 changes: 38 additions & 38 deletions schemas/fingerprint-server-api-for-sdks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ info:

> This version of Server API is marked as deprecated starting on **Jan 7th
2026** according to our [API Deprecation
Policy](https://dev.fingerprint.com/reference/api-deprecation-policy). If
Policy](https://docs.fingerprint.com/reference/api-deprecation-policy). If
you still use this version, please follow our [migration
guide](https://dev.fingerprint.com/reference/migrating-from-server-api-v3-to-v4)
guide](https://docs.fingerprint.com/reference/migrating-from-server-api-v3-to-v4)
to migrate from this deprecated version to the new one.


Expand All @@ -35,7 +35,7 @@ tags:
analysis events or event history of individual visitors.
externalDocs:
description: API documentation
url: https://dev.fingerprint.com/reference/pro-server-api
url: https://docs.fingerprint.com/reference/v3/server-api
servers:
- url: https://api.fpjs.io
description: Global
Expand All @@ -60,9 +60,9 @@ paths:

> This version of Server API is marked as deprecated starting on **Jan
7th 2026** according to our [API Deprecation
Policy](https://dev.fingerprint.com/reference/api-deprecation-policy).
Policy](https://docs.fingerprint.com/reference/api-deprecation-policy).
If you still use this version, please follow our [migration
guide](https://dev.fingerprint.com/reference/migrating-from-server-api-v3-to-v4#migrating-get-events)
guide](https://docs.fingerprint.com/reference/migrating-from-server-api-v3-to-v4#migrating-get-/events)
to migrate from this deprecated version to the new one.


Expand All @@ -86,7 +86,7 @@ paths:
type: string
description: >-
The unique
[identifier](https://dev.fingerprint.com/reference/get-function#requestid)
[identifier](https://docs.fingerprint.com/reference/v3/js-agent-get-function#requestid)
of each identification request.
responses:
'200':
Expand Down Expand Up @@ -675,9 +675,9 @@ paths:

> This version of Server API is marked as deprecated starting on **Jan
7th 2026** according to our [API Deprecation
Policy](https://dev.fingerprint.com/reference/api-deprecation-policy).
Policy](https://docs.fingerprint.com/reference/api-deprecation-policy).
If you still use this version, please follow our [migration
guide](https://dev.fingerprint.com/reference/migrating-from-server-api-v3-to-v4#migrating-update-events)
guide](https://docs.fingerprint.com/reference/migrating-from-server-api-v3-to-v4#migrating-update-/events)
to migrate from this deprecated version to the new one.


Expand All @@ -700,7 +700,7 @@ paths:
type: string
description: >-
The unique event
[identifier](https://dev.fingerprint.com/reference/get-function#requestid).
[identifier](https://docs.fingerprint.com/reference/v3/js-agent-get-function#requestid).
requestBody:
required: true
content:
Expand Down Expand Up @@ -795,9 +795,9 @@ paths:

> This version of Server API is marked as deprecated starting on **Jan
7th 2026** according to our [API Deprecation
Policy](https://dev.fingerprint.com/reference/api-deprecation-policy).
Policy](https://docs.fingerprint.com/reference/api-deprecation-policy).
If you still use this version, please follow our [migration
guide](https://dev.fingerprint.com/reference/migrating-from-server-api-v3-to-v4#migrating-get-eventssearch)
guide](https://docs.fingerprint.com/reference/migrating-from-server-api-v3-to-v4#migrating-get-/events/search)
to migrate from this deprecated version to the new one.


Expand Down Expand Up @@ -849,7 +849,7 @@ paths:
type: string
description: >
Unique [visitor
identifier](https://dev.fingerprint.com/reference/get-function#visitorid)
identifier](https://docs.fingerprint.com/reference/v3/js-agent-get-function#visitorid)
issued by Fingerprint Identification and all active Smart Signals.

Filter for events matching this `visitor_id`.
Expand Down Expand Up @@ -891,7 +891,7 @@ paths:


You can use [linked
IDs](https://dev.fingerprint.com/reference/get-function#linkedid) to
IDs](https://docs.fingerprint.com/reference/v3/js-agent-get-function#linkedid) to
associate identification requests with your own identifier, for
example, session ID, purchase ID, or transaction ID. You can then
use this `linked_id` parameter to retrieve all events associated
Expand Down Expand Up @@ -925,7 +925,7 @@ paths:
type: boolean
description: >
Filter events previously tagged as suspicious via the [Update
API](https://dev.fingerprint.com/reference/updateevent).
API](https://docs.fingerprint.com/reference/v3/server-api-update-event).

> Note: When using this parameter, only events with the `suspect`
property explicitly set to `true` or `false` are returned. Events
Expand Down Expand Up @@ -1703,9 +1703,9 @@ paths:

> This version of Server API is marked as deprecated starting on **Jan
7th 2026** according to our [API Deprecation
Policy](https://dev.fingerprint.com/reference/api-deprecation-policy).
Policy](https://docs.fingerprint.com/reference/api-deprecation-policy).
If you still use this version, please follow our [migration
guide](https://dev.fingerprint.com/reference/migrating-from-server-api-v3-to-v4#migrating-get-visitors)
guide](https://docs.fingerprint.com/reference/migrating-from-server-api-v3-to-v4#migrating-get-/visitors)
to migrate from this deprecated version to the new one.


Expand Down Expand Up @@ -1735,7 +1735,7 @@ paths:
type: string
description: >-
Unique [visitor
identifier](https://dev.fingerprint.com/reference/get-function#visitorid)
identifier](https://docs.fingerprint.com/reference/v3/js-agent-get-function#visitorid)
issued by Fingerprint Identification and all active Smart Signals.
- name: request_id
in: query
Expand All @@ -1748,7 +1748,7 @@ paths:
Every identification request has a unique identifier associated with
it called `requestId`. This identifier is returned to the client in
the identification
[result](https://dev.fingerprint.com/reference/get-function#requestid).
[result](https://docs.fingerprint.com/reference/v3/js-agent-get-function#requestid).
When you filter visits by `requestId`, only one visit will be
returned.
x-go-skip-pointer: true
Expand All @@ -1761,7 +1761,7 @@ paths:


You can use
[`linkedId`](https://dev.fingerprint.com/reference/get-function#linkedid)
[`linkedId`](https://docs.fingerprint.com/reference/v3/js-agent-get-function#linkedid)
to associate identification requests with your own identifier, for
example: session ID, purchase ID, or transaction ID. You can then
use this `linked_id` parameter to retrieve all events associated
Expand Down Expand Up @@ -1964,9 +1964,9 @@ paths:

> This version of Server API is marked as deprecated starting on **Jan
7th 2026** according to our [API Deprecation
Policy](https://dev.fingerprint.com/reference/api-deprecation-policy).
Policy](https://docs.fingerprint.com/reference/api-deprecation-policy).
If you still use this version, please follow our [migration
guide](https://dev.fingerprint.com/reference/migrating-from-server-api-v3-to-v4)
guide](https://docs.fingerprint.com/reference/migrating-from-server-api-v3-to-v4)
to migrate from this deprecated version to the new one.


Expand All @@ -1988,15 +1988,15 @@ paths:
- Upon request to delete, this data is deleted asynchronously (typically
within a few minutes) and it will no longer be used to identify this
browser (or device) for your [Fingerprint
Workspace](https://dev.fingerprint.com/docs/glossary#fingerprint-workspace).
Workspace](https://docs.fingerprint.com/docs/v3/glossary#fingerprint-workspace).


#### Identification requests made from this browser (or device)

- Fingerprint stores the identification requests made from a browser (or
device) for up to 30 (or 90) days depending on your plan. To learn more,
see [Data
Retention](https://dev.fingerprint.com/docs/regions#data-retention).
Retention](https://docs.fingerprint.com/docs/v3/regions#data-retention).

- Upon request to delete, the identification requests that were made by
this browser
Expand All @@ -2011,12 +2011,12 @@ paths:
a different visitor ID.

- If you request [`/events`
API](https://dev.fingerprint.com/reference/getevent) with a `request_id`
API](https://docs.fingerprint.com/reference/v3/server-api-get-event) with a `request_id`
that was made outside of the 10 days, you will still receive a valid
response.

- If you request [`/visitors`
API](https://dev.fingerprint.com/reference/getvisits) for the deleted
API](https://docs.fingerprint.com/reference/v3/server-api-get-visits) for the deleted
visitor ID, the response will include identification requests that were
made outside of those 10 days.

Expand All @@ -2033,7 +2033,7 @@ paths:
type: string
description: >-
The [visitor
ID](https://dev.fingerprint.com/reference/get-function#visitorid)
ID](https://docs.fingerprint.com/reference/v3/js-agent-get-function#visitorid)
you want to delete.
responses:
'200':
Expand Down Expand Up @@ -2157,7 +2157,7 @@ paths:

> This version of Server API is marked as deprecated starting on **Jan
7th 2026** according to our [API Deprecation
Policy](https://dev.fingerprint.com/reference/api-deprecation-policy).
Policy](https://docs.fingerprint.com/reference/api-deprecation-policy).


Related visitors API lets you link web visits and in-app browser visits
Expand All @@ -2176,7 +2176,7 @@ paths:
[support team](https://fingerprint.com/support).

To learn more, see [Related visitors API
reference](https://dev.fingerprint.com/reference/related-visitors-api).
reference](https://docs.fingerprint.com/reference/related-visitors-api).
parameters:
- name: visitor_id
in: query
Expand All @@ -2185,7 +2185,7 @@ paths:
type: string
description: >-
The [visitor
ID](https://dev.fingerprint.com/reference/get-function#visitorid)
ID](https://docs.fingerprint.com/reference/v3/js-agent-get-function#visitorid)
for which you want to find the other visitor IDs that originated
from the same mobile device.
responses:
Expand Down Expand Up @@ -2312,7 +2312,7 @@ paths:
description: >-
Fake path to describe webhook format. More information about webhooks
can be found in the
[documentation](https://dev.fingerprint.com/docs/webhooks)
[documentation](https://docs.fingerprint.com/docs/v3/webhooks)
x-flatten-optional-params: true
requestBody:
content:
Expand Down Expand Up @@ -2666,7 +2666,7 @@ components:
This field is **deprecated** and will not return a result for
**applications created after January 23rd, 2024**. Please use the [IP
Geolocation Smart
signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation)
signal](https://docs.fingerprint.com/docs/v3/smart-signals-reference#ip-geolocation)
for geolocation information.
additionalProperties: false
properties:
Expand Down Expand Up @@ -2857,7 +2857,7 @@ components:
description: >-
Field is `true` if you have previously set the `suspect` flag for
this event using the [Server API Update event
endpoint](https://dev.fingerprint.com/reference/updateevent).
endpoint](https://docs.fingerprint.com/reference/v3/server-api-update-event).
type: boolean
timestamp:
description: Timestamp of the event with millisecond precision in Unix time.
Expand Down Expand Up @@ -3532,7 +3532,7 @@ components:
to the *epoch* time (i.e 1 Jan 1970 UTC).

See [Factory Reset
Detection](https://dev.fingerprint.com/docs/smart-signals-overview#factory-reset-detection)
Detection](https://docs.fingerprint.com/docs/v3/smart-signals-reference#factory-reset-detection)
to learn more about this Smart Signal.
timestamp:
type: integer
Expand Down Expand Up @@ -3737,7 +3737,7 @@ components:
Smart Signals present in the payload that helps identify suspicious
activity. The value range is [0; S] where S is sum of all Smart
Signals weights. See more details here:
https://dev.fingerprint.com/docs/suspect-score
https://docs.fingerprint.com/docs/v3/suspect-score
ProductSuspectScore:
type: object
additionalProperties: false
Expand Down Expand Up @@ -3900,7 +3900,7 @@ components:
* `false` - Otherwise or when the request originated from a browser.

See [MitM Attack
Detection](https://dev.fingerprint.com/docs/smart-signals-reference#mitm-attack-detection)
Detection](https://docs.fingerprint.com/docs/v3/smart-signals-reference#mitm-attack-detection)
to learn more about this Smart Signal.
ProductMitMAttack:
type: object
Expand Down Expand Up @@ -4410,7 +4410,7 @@ components:
to the *epoch* time (i.e 1 Jan 1970 UTC).

See [Factory Reset
Detection](https://dev.fingerprint.com/docs/smart-signals-overview#factory-reset-detection)
Detection](https://docs.fingerprint.com/docs/v3/smart-signals-reference#factory-reset-detection)
to learn more about this Smart Signal.
timestamp:
type: integer
Expand Down Expand Up @@ -4521,7 +4521,7 @@ components:
Smart Signals present in the payload that helps identify suspicious
activity. The value range is [0; S] where S is sum of all Smart
Signals weights. See more details here:
https://dev.fingerprint.com/docs/suspect-score
https://docs.fingerprint.com/docs/v3/suspect-score
WebhookRemoteControl:
type: object
deprecated: true
Expand Down Expand Up @@ -4607,7 +4607,7 @@ components:
* `false` - Otherwise or when the request originated from a browser.

See [MitM Attack
Detection](https://dev.fingerprint.com/docs/smart-signals-overview#mitm-attack-detection)
Detection](https://docs.fingerprint.com/docs/v3/smart-signals-reference#mitm-attack-detection)
to learn more about this Smart Signal.
WebhookRareDevice:
type: object
Expand Down
Loading
Loading