Tools
OpenAPI and Postman
Download the OpenAPI 3.1 file, the Postman collection and environment, and the SDK kit files.
Files
| File | What it is |
|---|---|
openapi.yaml | OpenAPI 3.1: every route, schema, header and webhook (docs/api/openapi.yaml). |
postman-collection.json | Postman collection: the 95 documented endpoints with examples and tests. |
postman-environment.json | Postman environment with the base URLs and secret key variables. |
Use them
The OpenAPI file works with openapi-generator, Insomnia, Bruno and Stoplight. In Postman, choose Import, drop the collection and the environment, select Passkey-X (production) and paste your key into orgApiKey (it is marked secret). Folder-level Bearer auth reads {{userToken}}, {{orgApiKey}} and {{agentToken}}.
# TypeScript types for every route
npx openapi-typescript https://passkey-x.com/openapi.yaml -o passkey-x.d.ts
# Run the Postman collection in CI
npx newman run https://passkey-x.com/api-docs/postman-collection.json \
--env-var "orgApiKey=$PASSKEY_X_API_KEY" --folder "Key and audit"SDK kit
The JavaScript / TypeScript SDK 1.1.0, as files:
- index.mjsThe client
- index.d.tsTypeScript types
- webhooks.mjsWebhook verification
- webhooks.d.tsIts types
- package.jsonnpm package manifest
- README.mdGuide and options
Need help building on Passkey-X?
Questions about the API, a bug or a missing endpoint? Our team replies by email, usually within one business day.