# Cr3dentials

> Verify income, work history, and reputation from any web-based account with zkTLS and zero-knowledge proofs.

## Docs

- [Introduction](https://docs.cr3dentials.xyz/introduction.md): Cr3dentials verifies income, work history, and reputation from any web-based account using zkTLS and zero-knowledge proofs, without exposing the underlying data.
- [How Cr3dentials Works](https://docs.cr3dentials.xyz/getting-started/how-it-works.md): How Cr3dentials uses zkTLS and zero-knowledge proofs to verify data from web-based platforms without exposing login credentials or raw data.
- [Quickstart](https://docs.cr3dentials.xyz/getting-started/quickstart.md): Start verifying users with the no-code dashboard or the Partner API.
- [Partner Portal Guide](https://docs.cr3dentials.xyz/guides/partner-portal.md): Manage your team and API keys in the Cr3dentials Partner Portal.
- [API Integration Guide](https://docs.cr3dentials.xyz/guides/api-integration.md): Integrate iframe-based verification into your product with the Partner API.
- [Authentication](https://docs.cr3dentials.xyz/authentication.md): Authenticate every Partner API request with your API key.
- [Webhooks](https://docs.cr3dentials.xyz/essentials/webhooks.md): Receive verification results in real time instead of polling.
- [Rate Limits](https://docs.cr3dentials.xyz/essentials/rate-limits.md): Fair-usage limits, response headers, and how to handle them.
- [Supported Data Sources](https://docs.cr3dentials.xyz/platforms/supported-data-sources.md): Platforms Cr3dentials can verify today, with coverage by data type.
- [System Architecture](https://docs.cr3dentials.xyz/security/architecture.md): How Cr3dentials verifies credentials with zero-knowledge proofs and cryptographic attestations without storing or accessing sensitive data.
- [Data Handling & Privacy](https://docs.cr3dentials.xyz/security/data-handling.md): What Cr3dentials collects, what it never collects, and how zero-knowledge architecture protects your data end to end.
- [FAQ](https://docs.cr3dentials.xyz/resources/faq.md): Common questions about how Cr3dentials verifies income and activity.
- [Contact Us](https://docs.cr3dentials.xyz/resources/contact.md): How to reach the Cr3dentials team for access and support.
- [API Reference](https://docs.cr3dentials.xyz/api-reference/introduction.md): Base URLs, authentication, and conventions for the Partner API.
- [Get available platforms](https://docs.cr3dentials.xyz/api-reference/platforms/get-available-platforms.md): Retrieves the list of verification platforms available for browser sessions.
- [Get notification platforms](https://docs.cr3dentials.xyz/api-reference/platforms/get-notification-platforms.md): Returns the active notification channels (e.g. email, WhatsApp). Use a channel's `id` as `notificationPlatformId` when creating a session to have Cr3dentials send the verification link to your applicant.
- [Get approved email templates](https://docs.cr3dentials.xyz/api-reference/platforms/get-approved-email-templates.md): Returns your team's APPROVED email templates. Use a template's `id` as `emailTemplateId` when creating a session with an email `notificationPlatformId`.
- [List supported countries](https://docs.cr3dentials.xyz/api-reference/sessions/list-supported-countries.md): Countries where verification sessions are supported. Pass `country` for its regions, and `country`+`region` for its cities. Use these values for the required `location` field when creating a session.
- [Create browser session](https://docs.cr3dentials.xyz/api-reference/sessions/create-browser-session.md): Initiates a new verification session for a given platform. Returns an `embedUrl` to load in an iframe.
- [Get browser session](https://docs.cr3dentials.xyz/api-reference/sessions/get-browser-session.md): Retrieves the current status and results of a browser session. Poll this endpoint to detect completion or check verification results.
- [Terminate browser session](https://docs.cr3dentials.xyz/api-reference/sessions/terminate-browser-session.md): Ends a session early and releases its remote browser immediately instead of waiting for expiry. Use it when your applicant abandons the flow or you cancel the check on your side. The call is idempotent: a session that already reached a terminal status is left untouched and its existing status is ret…
- [Get session recording](https://docs.cr3dentials.xyz/api-reference/sessions/get-session-recording.md): Returns a fresh, time-limited video recording URL for a browser session that ended in an error state. Recordings are only exposed for sessions whose status is `ERROR` — use this to review what the applicant saw when a verification failed. The URL is a presigned link generated on demand and expires r…
- [List browser sessions](https://docs.cr3dentials.xyz/api-reference/sessions/list-browser-sessions.md): Returns a paginated list of browser sessions created by your API key.

## OpenAPI Specs

- [openapi](https://docs.cr3dentials.xyz/api-reference/openapi.json)