fingerprintjs / fingerprint-pro-server-api-openapi

OpenAPI definition for the Fingerprint Pro server API

Fingerprint Pro Server API OpenAPI Schema

Fingerprint is a device intelligence platform offering 99.5% accurate visitor identification. Fingerprint Server API allows you to retrieve visitor history or individual identification events in a server environment.

This repository contains the OpenAPI 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.

Getting started

• The OpenAPI schema is published to the Fingerprint API reference and also as a Swagger UI app on GitHub pages.
• You can also download the latest schema file here.

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.

FAQ

Why OpenAPI 3.0.3 version?

It is the last version supported by swagger-codegen. See more information in the related GitHub issue.

Support and feedback

To report problems, ask questions, or provide feedback, please use Issues. If you need private support, you can email us at [email protected].

License

This project is licensed under the MIT license.

fingerprint-pro-server-api-openapi's Issues

Add a botd url to the definition

Add the new BotD's url param to the definition.

Check also the docs are up to date

ipv4 field format not correct

Webhooks and server API can recognize the ipv6 format now. Our spec is obsolete since it says about ipv4 format only.

StSeenAt Type Naming

StSeenAt type naming might be confusing. Consider renaming it e.g. to SeenAt.

Even though it's just a type name, it might cause breaking changes in some specific usages. Add it to the new major version only.

schemas vs schemes

I think this project is using the word "schemes" incorrectly, it should be "schemas".

Example usage:
Corruption scheme
vs
Database schema