GrayPass
Docs
Download PDF
For agents

Versions and compatibility

This manual documents the canonical /api/v1 API, contract version 2026-10-01, and browser core SDK version 1.0.1 and Node SDK version 1.0.0. The API version identifies the service contract. The website provides the current documentation.

Inspect the service you use

GET /api/v1/meta returns the service API version and capability information without a customer credential. Your backend can call GET /api/v1/credential, or the Node client's credential(), to check its tenant, environment, scope, and proof issuer. Compare those values with your integration configuration before creating resources or diagnosing a mismatch.

A sandbox key, subject, action, and proof belong to the same environment. Create the corresponding resources and credentials separately in each environment. Keep separate configuration and application state for sandbox and live use.

Install compatible packages

Follow Getting started to obtain the versioned JavaScript SDK archives and their checksums. They contain prebuilt JavaScript and TypeScript definitions. Keep the supplied checksums and your dependency lockfile so the same package bytes can be installed again.

Use the documented methods in the delivered package. For operations such as policy activation and evaluation management, use the direct HTTP interfaces described in the API reference. The SDK guides describe available client methods and verifier behavior.

Upgrade procedure

  1. Review the new version's interface changes against the operations your application uses.
  2. Obtain the archives and matching checksums, verify each archive, and update the dependency lockfile.
  3. Run the sandbox quickstart and your application's request-binding, challenge, replay, expiry, and lifecycle checks.
  4. If you already use camera evidence, confirm a compatible approved camera asset set separately before upgrading. Use the camera package's dist/gaze/ directory and preserve its complete runtime and notices; verify worker and WASM loading from your own origin.
  5. Record the API contract, package versions, active policy version, and application version together. Retain a compatible rollback configuration.
  6. Roll out through your normal process and watch API errors, refusal reasons, and outcome-report lag.

For a changed response after an upgrade, check the returned code and expected binding before retrying. Keep the operation pending during investigation; report the contract and package versions with a sanitized reproduction to founders@graypass.org.

Read a saved edition

The PDF and website contain the same chapters and reference material. Match a saved edition to /api/v1/meta and your installed SDK versions. Obtain customer-specific agreements and security review material through your GrayPass contact.