https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi
OpenAPI definition for the Fingerprint Pro server API
https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi
Last synced: 8 months ago
JSON representation
OpenAPI definition for the Fingerprint Pro server API
- Host: GitHub
- URL: https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi
- Owner: fingerprintjs
- License: mit
- Created: 2022-06-15T07:50:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-25T07:57:06.000Z (9 months ago)
- Last Synced: 2025-05-01T01:41:10.853Z (8 months ago)
- Language: TypeScript
- Homepage:
- Size: 5.92 MB
- Stars: 9
- Watchers: 15
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Fingerprint Pro Server API OpenAPI Schema
[Fingerprint](https://fingerprint.com) is a device intelligence platform offering 99.5% accurate visitor identification. Fingerprint [Server API](https://dev.fingerprint.com/reference/pro-server-api) allows you to retrieve visitor history or individual identification events in a server environment.
This repository contains the [OpenAPI](https://swagger.io/docs/specification/about/) schema of the Fingerprint Server API. You can use it as a reference, to try the API or to generate types for your code. It's the basis for all available [Fingerprint Server SDKs](https://dev.fingerprint.com/docs/backend-libraries).
## Getting started
- The OpenAPI schema is published to the [Fingerprint API reference](https://dev.fingerprint.com/reference/pro-server-api) and also as a [Swagger UI app on GitHub pages](https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/).
- You can also [download the latest schema file here](https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas/fingerprint-server-api.yaml).
> [!NOTE]
> Please note that some signals and attributes present in the schema are only available to Enterprise or Pro Plus customers on request, as indicated in the signal description.
## Editing the schema
See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
## FAQ
#### Why OpenAPI 3.0.3 version?
It is the last version supported by `swagger-codegen`. See more information in the [related GitHub issue](https://github.com/swagger-api/swagger-codegen/issues/11627).
## Support and feedback
To report problems, ask questions, or provide feedback, please use [Issues](https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi/issues). If you need private support, you can email us at [oss-support@fingerprint.com](mailto:oss-support@fingerprint.com).
## License
This project is licensed under the [MIT license](./LICENSE).