# Neostra ## Documentation - [Introduction to Neostra](https://neostra.documentationai.com/introduction.md): Neostra is a modular, multi-tenant privacy compliance platform that automates global regulations including India's DPDPA 2023, the EU's GDPR, and California's CCPA. - [Platform Architecture](https://neostra.documentationai.com/architecture.md): Neostra's microservices architecture, service interactions, data flows, and database strategy. - [Quickstart](https://neostra.documentationai.com/quickstart.md): Set up your Neostra tenant, configure your first DSAR workflow, and submit a test privacy request. - [Privacy Rights Manager (DSAR)](https://neostra.documentationai.com/modules/dsar.md): Manage data subject access requests end-to-end with configurable intake forms, identity verification, automated workflows, and audit logging. - [Consent & Preference Management Platform](https://neostra.documentationai.com/modules/consent-management.md): Collect, store, and manage user consent with a CDN-hosted cookie banner, tamper-evident ledger, website scanning, and preference center. - [Data Discovery](https://neostra.documentationai.com/modules/data-discovery.md): Automated scanning and PII detection across your data landscape - [Governance & Compliance](https://neostra.documentationai.com/modules/governance.md): Assessments, compliance frameworks, privacy centers, and evidence management - [Breach Management](https://neostra.documentationai.com/modules/breach-management.md): Incident reporting, configurable intake forms, and breach response workflows - [Authentication](https://neostra.documentationai.com/developer/authentication.md): JWT-based stateless authentication with dual token system, 2FA, and fine-grained permissions. - [Multi-Tenancy](https://neostra.documentationai.com/developer/multi-tenancy.md): Tenant isolation, RBAC, brand access control, feature flags, and subscription management. - [Local Development Setup](https://neostra.documentationai.com/developer/local-setup.md): Step-by-step guide to running the Neostra platform locally for development. ## API Reference - [Sign in](https://neostra.documentationai.com/api-reference/post-api-v1-auth-signin.md): Authenticates a user and returns a JWT token. - [Select tenant](https://neostra.documentationai.com/api-reference/post-api-v1-auth-select-tenant.md): Exchange an initial JWT for a tenant-scoped JWT. - [Get registration info](https://neostra.documentationai.com/api-reference/get-api-v1-auth-signup-token.md): No description found - [Register user](https://neostra.documentationai.com/api-reference/patch-api-v1-auth-signup-token.md): No description found - [Request password reset](https://neostra.documentationai.com/api-reference/post-api-v1-auth-reset-password.md): No description found - [Update password](https://neostra.documentationai.com/api-reference/patch-api-v1-auth-reset-password-token.md): No description found - [Setup 2FA](https://neostra.documentationai.com/api-reference/post-api-v1-auth-2fa-setup.md): Returns a QR code URI for TOTP enrolment. - [Verify 2FA code](https://neostra.documentationai.com/api-reference/post-api-v1-auth-2fa-verify.md): No description found - [Create subject request (public)](https://neostra.documentationai.com/api-reference/post-api-v1-public-subject-request-create.md): No description found - [Check verification status](https://neostra.documentationai.com/api-reference/get-api-v1-public-subject-request-verification.md): No description found - [Verify subject request (email / affidavit)](https://neostra.documentationai.com/api-reference/post-api-v1-public-subject-request-verification.md): No description found - [List subject requests](https://neostra.documentationai.com/api-reference/get-api-v1-subjectrequest-list.md): No description found - [Get request details](https://neostra.documentationai.com/api-reference/get-api-v1-subjectrequest-requestid.md): No description found - [Update request](https://neostra.documentationai.com/api-reference/patch-api-v1-subjectrequest-requestid.md): No description found - [Create workflow](https://neostra.documentationai.com/api-reference/post-api-v1-workflow-create.md): No description found - [List workflows](https://neostra.documentationai.com/api-reference/get-api-v1-workflow.md): No description found - [Get workflow](https://neostra.documentationai.com/api-reference/get-api-v1-workflow-workflowid.md): No description found - [Update workflow](https://neostra.documentationai.com/api-reference/patch-api-v1-workflow-workflowid.md): No description found - [Delete workflow](https://neostra.documentationai.com/api-reference/delete-api-v1-workflow-workflowid.md): No description found - [Publish workflow](https://neostra.documentationai.com/api-reference/post-api-v1-workflow-workflowid-publish.md): No description found - [Discard draft](https://neostra.documentationai.com/api-reference/post-api-v1-workflow-workflowid-discard.md): No description found - [Export workflow](https://neostra.documentationai.com/api-reference/get-api-v1-workflow-workflowid-export.md): No description found - [Import workflow](https://neostra.documentationai.com/api-reference/post-api-v1-workflow-import.md): No description found - [List tasks](https://neostra.documentationai.com/api-reference/get-api-v1-task-list.md): No description found - [Get task](https://neostra.documentationai.com/api-reference/get-api-v1-task-taskid.md): No description found - [Update task](https://neostra.documentationai.com/api-reference/patch-api-v1-task-taskid.md): No description found - [Assign task](https://neostra.documentationai.com/api-reference/post-api-v1-task-taskid-assign.md): No description found - [Complete task](https://neostra.documentationai.com/api-reference/post-api-v1-task-taskid-complete.md): No description found - [Create assessment](https://neostra.documentationai.com/api-reference/post-api-v1-assessment-create.md): No description found - [List assessments](https://neostra.documentationai.com/api-reference/get-api-v1-assessment-list.md): No description found - [Get assessment](https://neostra.documentationai.com/api-reference/get-api-v1-assessment-assessmentid.md): No description found - [Update assessment](https://neostra.documentationai.com/api-reference/post-api-v1-assessment-assessmentid.md): No description found - [Complete assessment](https://neostra.documentationai.com/api-reference/post-api-v1-assessment-complete-assessmentid.md): No description found - [Export assessment to PDF](https://neostra.documentationai.com/api-reference/get-api-v1-assessment-export-assessmentid.md): No description found - [Get dashboard summary](https://neostra.documentationai.com/api-reference/get-api-v1-assessment-dashboard.md): No description found - [List templates](https://neostra.documentationai.com/api-reference/get-api-v1-assessment-templates.md): No description found - [Create template](https://neostra.documentationai.com/api-reference/post-api-v1-assessment-templates-create.md): No description found - [Get template](https://neostra.documentationai.com/api-reference/get-api-v1-assessment-templates-templateid.md): No description found - [Delete template](https://neostra.documentationai.com/api-reference/delete-api-v1-assessment-templates-templateid.md): No description found - [Update draft template](https://neostra.documentationai.com/api-reference/patch-api-v1-assessment-templates-drafttemplateid.md): No description found - [Publish template](https://neostra.documentationai.com/api-reference/post-api-v1-assessment-templates-draft-drafttemplateid-publish.md): No description found - [Discard draft template](https://neostra.documentationai.com/api-reference/post-api-v1-assessment-templates-draft-drafttemplateid-discard.md): No description found - [Create banner](https://neostra.documentationai.com/api-reference/post-api-v1-banners-create.md): No description found - [List banners](https://neostra.documentationai.com/api-reference/get-api-v1-banners.md): No description found - [Get banner](https://neostra.documentationai.com/api-reference/get-api-v1-banners-bannerid.md): No description found - [Update banner](https://neostra.documentationai.com/api-reference/patch-api-v1-banners-bannerid.md): No description found - [Delete banner](https://neostra.documentationai.com/api-reference/delete-api-v1-banners-bannerid.md): No description found - [Publish banner](https://neostra.documentationai.com/api-reference/post-api-v1-banners-bannerid-publish.md): No description found - [Create brand](https://neostra.documentationai.com/api-reference/post-api-v1-brand-create.md): No description found - [List brands](https://neostra.documentationai.com/api-reference/get-api-v1-brand.md): No description found - [Update brand](https://neostra.documentationai.com/api-reference/patch-api-v1-brand-brandid.md): No description found - [Delete brand](https://neostra.documentationai.com/api-reference/delete-api-v1-brand-brandid.md): No description found - [Get tenant](https://neostra.documentationai.com/api-reference/get-api-v1-tenant-tenantid.md): No description found - [Update tenant](https://neostra.documentationai.com/api-reference/patch-api-v1-tenant-tenantid.md): No description found - [Current user's tenant](https://neostra.documentationai.com/api-reference/get-api-v1-tenant-tenant-info.md): No description found - [List users](https://neostra.documentationai.com/api-reference/get-api-v1-user.md): No description found - [Create / invite user](https://neostra.documentationai.com/api-reference/post-api-v1-user-create.md): No description found - [Update user](https://neostra.documentationai.com/api-reference/patch-api-v1-user-userid.md): No description found - [Delete user](https://neostra.documentationai.com/api-reference/delete-api-v1-user-userid.md): No description found - [Create form](https://neostra.documentationai.com/api-reference/post-api-v1-forms-create.md): No description found - [List forms](https://neostra.documentationai.com/api-reference/get-api-v1-forms.md): No description found - [Get form](https://neostra.documentationai.com/api-reference/get-api-v1-forms-formid.md): No description found - [Update form](https://neostra.documentationai.com/api-reference/patch-api-v1-forms-formid.md): No description found - [Publish form](https://neostra.documentationai.com/api-reference/post-api-v1-forms-formid-publish.md): No description found - [Upload file](https://neostra.documentationai.com/api-reference/post-api-v1-storage-file-upload.md): No description found - [Submit consent receipt](https://neostra.documentationai.com/api-reference/post-api-v1-consents.md): Accepts a consent receipt and queues it for ledger recording. Returns 202 Accepted. - [Get unified consent for subject](https://neostra.documentationai.com/api-reference/get-api-v1-consents-subjectid.md): No description found - [Verify ledger integrity](https://neostra.documentationai.com/api-reference/get-api-v1-ledger-verify.md): Walks the hash chain and returns an integrity report. - [Get ledger history for subject](https://neostra.documentationai.com/api-reference/get-api-v1-ledger-subject-subjectid.md): No description found - [Get paginated ledger entries](https://neostra.documentationai.com/api-reference/get-api-v1-ledger-entries.md): No description found - [Get total ledger entries count](https://neostra.documentationai.com/api-reference/get-api-v1-ledger-count.md): No description found - [Get entry by sequence number](https://neostra.documentationai.com/api-reference/get-api-v1-ledger-entry-sequencenumber.md): No description found - [Start website crawl](https://neostra.documentationai.com/api-reference/post-api-v1-crawl-start.md): Queues a new crawl job and returns a scanId. The crawl runs asynchronously. - [Cancel crawl](https://neostra.documentationai.com/api-reference/post-api-v1-crawl-cancel.md): No description found - [Get aggregated scan metrics](https://neostra.documentationai.com/api-reference/get-api-v1-report-scans-id-metrics.md): No description found - [Get scan cookies](https://neostra.documentationai.com/api-reference/get-api-v1-report-scans-id-metrics-cookies.md): No description found - [Get scan scripts](https://neostra.documentationai.com/api-reference/get-api-v1-report-scans-id-metrics-scripts.md): No description found - [Get scan iframes](https://neostra.documentationai.com/api-reference/get-api-v1-report-scans-id-metrics-iframes.md): No description found - [Get all scans](https://neostra.documentationai.com/api-reference/get-api-v1-report-scans-list.md): No description found - [Test Selenium Hub](https://neostra.documentationai.com/api-reference/get-api-v1-diagnostic-selenium-hub.md): Pings the Selenium Hub to verify connectivity. - [Test session creation](https://neostra.documentationai.com/api-reference/get-api-v1-diagnostic-selenium-hub-session.md): Creates and immediately destroys a Selenium session to verify the hub can allocate browsers. - [Generate OTP](https://neostra.documentationai.com/api-reference/post-api-v1-auth-otp-generate.md): Generates a one-time password for authentication. - [Register user](https://neostra.documentationai.com/api-reference/post-api-v1-auth-signup.md): Registers a new user with email, name, and organization details. - [Get cookie dashboard analytics](https://neostra.documentationai.com/api-reference/get-api-v1-dashboard-cookies.md): Returns cookie-related dashboard analytics for the specified tenant and date range. - [List data subject categories](https://neostra.documentationai.com/api-reference/get-api-v1-data-subjects.md): Returns a list of all data subject categories. - [Get data subject with consents](https://neostra.documentationai.com/api-reference/get-api-v1-data-subjects-userid.md): Returns a specific data subject along with their consent records. - [Get consent receipts by subject](https://neostra.documentationai.com/api-reference/get-api-v1-consent-receipt-subjectid.md): Returns all consent receipts associated with a specific data subject. - [List preference centers](https://neostra.documentationai.com/api-reference/get-api-v1-preference-center.md): Returns a list of all preference centers. - [Create preference center](https://neostra.documentationai.com/api-reference/post-api-v1-preference-center-create.md): Creates a new preference center. - [Update preference center](https://neostra.documentationai.com/api-reference/patch-api-v1-preference-center-id.md): Updates an existing preference center. - [List scans](https://neostra.documentationai.com/api-reference/get-api-v1-scans.md): Returns a list of all scans. - [Create scan](https://neostra.documentationai.com/api-reference/post-api-v1-scans.md): Creates a new data discovery scan. - [Get scan](https://neostra.documentationai.com/api-reference/get-api-v1-scans-scanid.md): Returns details of a specific scan. - [Update scan](https://neostra.documentationai.com/api-reference/patch-api-v1-scans-scanid.md): Updates an existing scan. - [List scan tasks](https://neostra.documentationai.com/api-reference/get-api-v1-scan-tasks.md): Returns a list of all scan tasks. - [Get scan task](https://neostra.documentationai.com/api-reference/get-api-v1-scan-tasks-taskid.md): Returns details of a specific scan task. - [Update scan task status](https://neostra.documentationai.com/api-reference/patch-api-v1-scan-tasks-taskid.md): Updates the status of an existing scan task. - [List findings](https://neostra.documentationai.com/api-reference/get-api-v1-findings.md): Returns a list of findings, optionally filtered by scan, data point, or category. - [Get finding](https://neostra.documentationai.com/api-reference/get-api-v1-findings-findingid.md): Returns details of a specific finding. - [List integrations](https://neostra.documentationai.com/api-reference/get-api-v1-integrations.md): Returns a list of all integrations. - [Create integration](https://neostra.documentationai.com/api-reference/post-api-v1-integrations.md): Creates a new external integration. - [Get integration](https://neostra.documentationai.com/api-reference/get-api-v1-integrations-integrationid.md): Returns details of a specific integration. - [Update integration](https://neostra.documentationai.com/api-reference/patch-api-v1-integrations-integrationid.md): Updates an existing integration. - [Delete integration](https://neostra.documentationai.com/api-reference/delete-api-v1-integrations-integrationid.md): Deletes an existing integration. - [List data systems](https://neostra.documentationai.com/api-reference/get-api-v1-data-systems.md): Returns a list of all registered data systems. - [Create data system](https://neostra.documentationai.com/api-reference/post-api-v1-data-systems.md): Registers a new data system. - [Get data system](https://neostra.documentationai.com/api-reference/get-api-v1-data-systems-id.md): Returns details of a specific data system. - [Update data system](https://neostra.documentationai.com/api-reference/patch-api-v1-data-systems-id.md): Updates an existing data system. - [Create data subject category](https://neostra.documentationai.com/api-reference/post-api-v1-data-subjects.md): Creates a new data subject category. - [Update data subject category](https://neostra.documentationai.com/api-reference/patch-api-v1-data-subjects-id.md): Updates an existing data subject category. - [List data points](https://neostra.documentationai.com/api-reference/get-api-v1-data-points.md): Returns a list of all data points. - [Get data point](https://neostra.documentationai.com/api-reference/get-api-v1-data-points-id.md): Returns details of a specific data point. - [List attributes](https://neostra.documentationai.com/api-reference/get-api-v1-attributes.md): Returns a list of all attribute definitions. - [Create attribute definition](https://neostra.documentationai.com/api-reference/post-api-v1-attributes.md): Creates a new attribute definition. - [Update attribute](https://neostra.documentationai.com/api-reference/patch-api-v1-attributes-id.md): Updates an existing attribute definition. - [List processing activities](https://neostra.documentationai.com/api-reference/get-api-v1-processing-activities.md): Returns a list of all processing activities. - [Create processing activity](https://neostra.documentationai.com/api-reference/post-api-v1-processing-activities.md): Creates a new processing activity record. - [Update processing activity](https://neostra.documentationai.com/api-reference/patch-api-v1-processing-activities-id.md): Updates an existing processing activity. - [List vendors](https://neostra.documentationai.com/api-reference/get-api-v1-vendors.md): Returns a list of all vendors. - [Create vendor](https://neostra.documentationai.com/api-reference/post-api-v1-vendors.md): Creates a new third-party vendor record. - [Update vendor](https://neostra.documentationai.com/api-reference/patch-api-v1-vendors-id.md): Updates an existing vendor record. - [Get analytics summary](https://neostra.documentationai.com/api-reference/get-api-v1-analytics.md): Returns an aggregated analytics summary across data discovery operations. - [Verify signup](https://neostra.documentationai.com/api-reference/patch-api-v1-auth-verify-token.md): Verifies a user's signup using the provided verification token. - [List tenants](https://neostra.documentationai.com/api-reference/get-api-v1-tenant.md): Returns a paginated list of all tenants. - [Get tenant](https://neostra.documentationai.com/api-reference/get-api-v1-tenant-id.md): Returns details of a specific tenant. - [Get tenant settings](https://neostra.documentationai.com/api-reference/get-api-v1-tenant-id-settings.md): Returns the settings for a specific tenant. - [Update tenant settings](https://neostra.documentationai.com/api-reference/patch-api-v1-tenant-tenantid-settings-settingsid.md): Updates specific settings for a tenant. - [Get tenant users](https://neostra.documentationai.com/api-reference/get-api-v1-tenant-id-users.md): Returns all users belonging to a specific tenant. - [Get all roles](https://neostra.documentationai.com/api-reference/get-api-v1-tenant-roles.md): Returns all available roles that can be assigned to tenant users. - [Update user role](https://neostra.documentationai.com/api-reference/patch-api-v1-tenant-tenantid-user-userid.md): Updates the role of a user within a specific tenant. - [List all users](https://neostra.documentationai.com/api-reference/get-api-v1-user-users.md): Returns a paginated list of all users. - [Get user's tenants](https://neostra.documentationai.com/api-reference/get-api-v1-user-id-tenants.md): Returns all tenants associated with a specific user. - [Get subscription plans](https://neostra.documentationai.com/api-reference/get-api-v1-subscription-plans.md): Returns all available subscription plans. - [Update subscription](https://neostra.documentationai.com/api-reference/patch-api-v1-subscription-tenantid.md): Updates the subscription for a specific tenant. ## SDK & Integration - [Integrations Overview](https://neostra.documentationai.com/integrations.md): Connect Neostra with your existing systems through REST APIs, external service integrations, and the cookie consent widget. - [Cookie Consent Modal](https://neostra.documentationai.com/sdk/cookie-modal.md): Embed and configure the Neostra cookie consent modal (CPMP Modal) built with Svelte 5. - [REST API Patterns](https://neostra.documentationai.com/sdk/rest-api.md): Common patterns for authentication, pagination, error handling, and file uploads across Neostra APIs. ## Help Center - [Help Center](https://neostra.documentationai.com/help-center.md): Find answers, troubleshooting guides, and integration tutorials for the Neostra platform. - [Getting Started FAQ](https://neostra.documentationai.com/help-center/faq/getting-started.md): Frequently asked questions about setting up and using the Neostra privacy compliance platform. - [Common Issues](https://neostra.documentationai.com/help-center/troubleshooting/common-issues.md): Solutions for frequently encountered issues with the Neostra platform. - [Embed the Cookie Consent Modal](https://neostra.documentationai.com/help-center/guides/embed-consent-modal.md): Step-by-step guide to adding the Neostra cookie consent banner to your website. ## Changelog - [Changelog](https://neostra.documentationai.com/changelog.md): Release history for the Neostra privacy compliance platform.