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
11 changes: 11 additions & 0 deletions .changeset/update-schema-v3.7.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
"fingerprint-pro-server-api-python-sdk": minor
---

Update Server API schema to `v3.7.1`:

- **errors**: Add `RequestReadTimeout` `ErrorCode` value and document `429`/`504` responses on affected endpoints.
- **events**: Require `label` on `LabelsInner` entries.
- **events-search**: Clarify that `reverse` defaults to `false` (sorted newest first) when omitted.
- **visitors**: Document that `GET /visitors/{visitor_id}` now returns at most one item in `visits`; use `GET /events/search` for multi-event history and pagination.
- Clarify `ProxyDetails.proxy_type` and other signal descriptions to match the updated API v3 documentation.
1 change: 1 addition & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ jobs:
with:
appId: ${{ vars.APP_ID }}
runnerAppId: ${{ vars.RUNNER_APP_ID }}
unmarkReleaseAsLatest: true
version-command: bash ./changeset-version.sh
publish-command: bash ./changeset-publish.sh
language: python
Expand Down
1 change: 1 addition & 0 deletions docs/ErrorCode.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
Error code:
* `RequestCannotBeParsed` - the query parameters or JSON payload contains some errors
that prevented us from parsing it (wrong type/surpassed limits).
* `RequestReadTimeout` - the request body could not be read before the connection timed out.
* `TokenRequired` - `Auth-API-Key` header is missing or empty.
* `TokenNotFound` - no Fingerprint application found for specified secret key.
* `SubscriptionNotActive` - Fingerprint application is not active.
Expand Down
32 changes: 17 additions & 15 deletions docs/FingerprintApi.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/LabelsInner.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**label** | **str** | | [optional]
**label** | **str** | |
**prediction** | **bool** | | [optional]
**ml_score** | **float** | | [optional]

Expand Down
2 changes: 1 addition & 1 deletion docs/ProxyDetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Proxy detection details (present if proxy is detected)
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**proxy_type** | **str** | Residential proxies use real user IP addresses to appear as legitimate traffic, while data center proxies are public proxies hosted in data centers. `unknown` is reported when a proxy is detected solely by the ML model and the IP sources did not determine a specific type. |
**proxy_type** | **str** | Proxy type: * `residential` - proxies that route through residential and telecom IP addresses to appear as legitimate traffic * `data_center` - proxies which route through data centers * `unknown` - reported when a proxy is detected solely by the ML model and the IP sources did not determine a specific type |
**last_seen_at** | **datetime** | ISO 8601 formatted timestamp in UTC with hourly resolution of when this IP was last seen as a proxy when available. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/VPNMethods.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
**auxiliary_mobile** | **bool** | This method applies to mobile devices only. Indicates the result of additional methods used to detect a VPN in mobile devices. |
**os_mismatch** | **bool** | The browser runs on a different operating system than the operating system inferred from the request network signature. |
**relay** | **bool** | Request IP address belongs to a relay service provider, indicating the use of relay services like [Apple Private relay](https://support.apple.com/en-us/102602) or [Cloudflare Warp](https://developers.cloudflare.com/warp-client/). * Like VPNs, relay services anonymize the visitor's true IP address. * Unlike traditional VPNs, relay services don't let visitors spoof their location by choosing an exit node in a different country. This field allows you to differentiate VPN users and relay service users in your fraud prevention logic. |
**ml_prediction** | **bool** | `true` if the request came from a device running a VPN, `false` otherwise. | [optional]
**ml_prediction** | **bool** | `true` if the request came from a device running a VPN, `false` otherwise. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2 changes: 1 addition & 1 deletion docs/VirtualMachine.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**result** | **bool** | `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise. |
**ml_score** | **float** | Machine learning-based virtual machine score, represented as a floating-point value between 0 and 1 (inclusive), with up to three decimal places of precision. A higher score means a higher confidence in the positive `virtual_machine` detection result | [optional]
**ml_score** | **float** | Machine learning-based virtual machine score, represented as a floating-point value between 0 and 1 (inclusive), with up to three decimal places of precision. A higher score means a higher confidence in the positive `virtual_machine` detection result | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

4 changes: 2 additions & 2 deletions docs/VisitorsGetResponse.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# VisitorsGetResponse
Pagination-related fields `lastTimestamp` and `paginationKey` are included if you use a pagination parameter like `limit` or `before` and there is more data available on the next page.
Deprecated response shape for `GET /visitors/{visitor_id}`. The `visits` array currently contains at most one item. Use `GET /events/search` for multi-event history and filtering.


## Properties
Expand All @@ -8,7 +8,7 @@ Name | Type | Description | Notes
**visitor_id** | **str** | |
**visits** | [**list[Visit]**](Visit.md) | |
**last_timestamp** | **int** | ⚠️ Deprecated paging attribute, please use `paginationKey` instead. Timestamp of the last visit in the current page of results. | [optional]
**pagination_key** | **str** | Request ID of the last visit in the current page of results. Use this value in the following request as the `paginationKey` parameter to get the next page of results. | [optional]
**pagination_key** | **str** | Use this value in the following request as the `paginationKey` parameter to get the next result. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2 changes: 1 addition & 1 deletion fingerprint_pro_server_api_sdk/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"""
Server API v3 (deprecated)

> 🚧 Deprecation Notice > > 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 you still use this version, please follow our [migration guide](https://dev.fingerprint.com/reference/migrating-from-server-api-v3-to-v4) to migrate from this deprecated version to the new one. Fingerprint Server API allows you to search, update, and delete identification events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device. # noqa: E501
> 🚧 Deprecation Notice > > 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 you still use this version, please follow our [migration guide](https://dev.fingerprint.com/reference/migrating-from-server-api-v3-to-v4) to migrate from this deprecated version to the new one. Fingerprint Server API allows you to search, update, and delete identification events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device. # noqa: E501

OpenAPI spec version: 3
Contact: support@fingerprint.com
Expand Down
Loading
Loading