Skip to content

Commit 8d98df7

Browse files
feat: update OpenAPI schema
1 parent a4adaac commit 8d98df7

22 files changed

+1512
-1964
lines changed

.changeset/orange-taxis-fetch.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'fingerprint-pro-server-api-java-sdk': minor
3+
---
4+
5+
**visitors**: Add the confidence field to the VPN Detection Smart Signal

.schema-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v1.2.0

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,6 @@ Class | Method | HTTP request | Description
369369
- [VelocityIntervals](docs/VelocityIntervals.md)
370370
- [VelocityResult](docs/VelocityResult.md)
371371
- [VirtualMachineResult](docs/VirtualMachineResult.md)
372-
- [Visit](docs/Visit.md)
373372
- [VpnResult](docs/VpnResult.md)
374373
- [VpnResultMethods](docs/VpnResultMethods.md)
375374
- [WebhookVisit](docs/WebhookVisit.md)

docs/FingerprintApi.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,28 @@ All URIs are relative to *https://api.fpjs.io*
1919
Delete data by visitor ID
2020

2121
Request deleting all data associated with the specified visitor ID. This API is useful for compliance with privacy regulations.
22-
All delete requests are queued:
23-
24-
* Recent data (10 days or newer) belonging to the specified visitor will be deleted within 24 hours.
25-
* Data from older (11 days or more) identification events will be deleted after 90 days.
26-
27-
If you are interested in using this API, please [contact our support team](https://fingerprint.com/support/) to enable it for you. Otherwise, you will receive a 403.
22+
### Which data is deleted?
23+
- Browser (or device) properties
24+
- Identification requests made from this browser (or device)
25+
26+
#### Browser (or device) properties
27+
- Represents the data that Fingerprint collected from this specific browser (or device) and everything inferred and derived from it.
28+
- 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 Application](https://dev.fingerprint.com/docs/glossary#fingerprint-application).
29+
30+
#### Identification requests made from this browser (or device)
31+
- 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).
32+
- Upon request to delete, the identification requests that were made by this browser
33+
- Within the past 10 days are deleted within 24 hrs.
34+
- Outside of 10 days are allowed to purge as per your data retention period.
35+
36+
### Corollary
37+
After requesting to delete a visitor ID,
38+
- If the same browser (or device) requests to identify, it will receive a different visitor ID.
39+
- If you request [`/events` API](https://dev.fingerprint.com/reference/getevent) with a `request_id` that was made outside of the 10 days, you will still receive a valid response.
40+
- If you request [`/visitors` API](https://dev.fingerprint.com/reference/getvisits) for the deleted visitor ID, the response will include identification requests that were made outside of those 10 days.
41+
42+
### Interested?
43+
Please [contact our support team](https://fingerprint.com/support/) to enable it for you. Otherwise, you will receive a 403.
2844

2945

3046
### Example

docs/Visit.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

docs/VpnResult.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,16 @@
1111
|**originTimezone** | **String** | Local timezone which is used in timezoneMismatch method. | |
1212
|**originCountry** | **String** | Country of the request (only for Android SDK version >= 2.4.0, ISO 3166 format or unknown). | [optional] |
1313
|**methods** | [**VpnResultMethods**](VpnResultMethods.md) | | |
14+
|**confidence** | [**ConfidenceEnum**](#ConfidenceEnum) | A confidence rating for the VPN detection result — \"low\", \"medium\", or \"high\". Depends on the combination of results returned from all VPN detection methods. | |
15+
16+
17+
## Enum: ConfidenceEnum
18+
19+
| Name | Value |
20+
|---- | ----- |
21+
| LOW | "low" |
22+
| MEDIUM | "medium" |
23+
| HIGH | "high" |
1424

1525

1626

0 commit comments

Comments
 (0)