Guides

Use these guides for task-based implementation workflows. Each guide explains the integration sequence and links to the API Reference for exact endpoint schemas, fields, and errors.

For architectural background, start with Core Concepts.

Account And Key Management

• Deriving The Login Bucket — derive the blind login index required for registration and login.
• Account Recovery — restore access using a recovery key when credentials are lost.
• Encrypted Profile Fields — read and update encrypted profile fields.
• Handling Client Key Material — decrypt private keys after login and handle key versioning and rotation.

Documents

• Document Upload — encrypt, upload, process, and index a document end to end.
• Document Management — list, retrieve, update, delete, and track documents.
• Document Verification — submit a document for enclave-based verification.
• Encrypted Search — generate blind index tokens and search encrypted document records.

Organizations And Sharing

• Creating And Claiming Grants — share documents through time-limited, consent-based grants.
• Entity Onboarding — create an organization, add members, and claim membership.
• Entity Deliveries — deliver encrypted document access directly to a specific organization member.

Platform Operations

• Job Polling — poll asynchronous jobs and handle retry/backoff behavior.
• Platform Keys — fetch platform public keys used for client-side document key wrapping.

Last updated on