fingerlydocs
fingerly.io Log inDashboard
API reference

OpenAPI and Postman

Download the OpenAPI 3.1 description of the Fingerly API and a Postman collection generated from it, to explore the API or generate a client.

The client, server and management APIs are described in one OpenAPI 3.1 document. It is generated from the routes the API serves, so it lists exactly the endpoints, parameters and fields they have.

FileUse it to
openapi.jsonGenerate a client, validate requests in tests, or import into an API tool.
fingerly.postman_collection.jsonExplore the API in Postman, one request per operation.
Download
curl -O https://docs.fingerly.io/openapi.json
curl -O https://docs.fingerly.io/fingerly.postman_collection.json

What the document covers

TagOperationsKey
Client APIIdentify, deferred reports, attestation challengesPublic
Server APIList events, get an eventSecret
Management APISDK keys, proxy keys, webhook endpoints, risk weightsManagement
  • Servers are listed per region. Use the one your keys belong to.
  • Each operation names the kind of key it accepts, as the publicKey, secretKey or managementKey security scheme. All three are sent in the x-api-key header.
  • Every error response uses the error body.
  • Webhook events are not operations you call, so they are not in the document. See the event envelope.

Import into Postman

  • In Postman, choose Import and select fingerly.postman_collection.json.
  • Open the collection's Variables and set baseUrl, the keys you want to use, and organizationId.
  • Send Describe the management key first to read your organizationId.

Generate a client

Any OpenAPI 3.1 generator can build a client from the document. Operation IDs are named for what the operation does, such as listEvents and issueSdkKey.

npx openapi-typescript https://docs.fingerly.io/openapi.json -o fingerly-api.d.ts

To read events and verify webhooks, the server SDKs are simpler than a generated client.

Versions

The document describes API v1. It changes only in the ways the versioning policy allows within a version, and every change is listed in the changelog. Write clients that ignore fields they do not know.

Last updated