# Minerva Docs

## Docs

- [Adverse Media Categories](https://docs.gominerva.com/adverse-media-categories.md): How to choose financial and non-financial adverse media risk categories by workspace and screening channel, including per-search API overrides.
- [Agent Risk Assessments Guide](https://docs.gominerva.com/agent-risk-assessments-guide.md): How to configure, submit, review, collaborate on, and report beta agent risk assessments.
- [Repeated Alert Suppression Guide](https://docs.gominerva.com/alert-suppression-guide.md): How to configure repeated alert suppression for monitored profiles and ongoing screening.
- [Create a latest run command](https://docs.gominerva.com/api-reference/agent-runtime/create-a-latest-run-command.md): Creates a generic command for the latest assessment-owned run. type accepts input, user_input, steer, steering, resume, cancel, or stop.
- [Create a run command by run id](https://docs.gominerva.com/api-reference/agent-runtime/create-a-run-command-by-run-id.md): Creates a generic command for a specific assessment-owned run.
- [Get assessment agent run by id](https://docs.gominerva.com/api-reference/agent-runtime/get-assessment-agent-run-by-id.md): Returns a specific assessment-owned agent-runtime run.
- [Get latest assessment agent run](https://docs.gominerva.com/api-reference/agent-runtime/get-latest-assessment-agent-run.md): Returns the latest agent-runtime run attached to the assessment.
- [List latest run commands](https://docs.gominerva.com/api-reference/agent-runtime/list-latest-run-commands.md): Lists input, steering, resume, and cancel commands for the latest assessment-owned run.
- [List latest run trajectory](https://docs.gominerva.com/api-reference/agent-runtime/list-latest-run-trajectory.md): Lists enriched agent trajectory records for the latest assessment-owned run.
- [List run commands by run id](https://docs.gominerva.com/api-reference/agent-runtime/list-run-commands-by-run-id.md): Lists input, steering, resume, and cancel commands for a specific assessment-owned run.
- [List run trajectory by run id](https://docs.gominerva.com/api-reference/agent-runtime/list-run-trajectory-by-run-id.md): Lists enriched agent trajectory records for a specific assessment-owned run.
- [Resume a run by run id](https://docs.gominerva.com/api-reference/agent-runtime/resume-a-run-by-run-id.md): Adds a resume command to a specific assessment-owned run and queues a follow-up turn when agent-runtime can run it.
- [Resume the latest run](https://docs.gominerva.com/api-reference/agent-runtime/resume-the-latest-run.md): Adds a resume command to the latest run and queues a follow-up turn when agent-runtime can run it.
- [Send user input to a run by run id](https://docs.gominerva.com/api-reference/agent-runtime/send-user-input-to-a-run-by-run-id.md): Adds a user_input command to a specific assessment-owned run.
- [Send user input to the latest run](https://docs.gominerva.com/api-reference/agent-runtime/send-user-input-to-the-latest-run.md): Adds a user_input command to the latest run. Use prompt for plain-text instructions and payload or artifact_refs for structured customer context.
- [Steer a run by run id](https://docs.gominerva.com/api-reference/agent-runtime/steer-a-run-by-run-id.md): Adds a steering command that changes how the agent should proceed on a specific assessment-owned run.
- [Steer the latest run](https://docs.gominerva.com/api-reference/agent-runtime/steer-the-latest-run.md): Adds a steering command that changes how the agent should proceed on the latest run.
- [API Keys](https://docs.gominerva.com/api-reference/api-keys.md): How to create and manage Minerva API keys and screening workflow webhooks from the Developers page.
- [Send API Result to User](https://docs.gominerva.com/api-reference/api-to-ui-integration/send-api-result-to-user.md): **"I have a manual review element to my onboarding flow, and need to send API results that match certain criteria to investigators in the UI for review."**
- [Append assessment uploads](https://docs.gominerva.com/api-reference/assessments/append-assessment-uploads.md): Adds upload references to an assessment. Raw file bytes are not accepted here; references should point to objects already uploaded through the approved storage path.
- [Cancel an assessment and cancel the latest run](https://docs.gominerva.com/api-reference/assessments/cancel-an-assessment-and-cancel-the-latest-run.md): Alias for stopping an assessment. This endpoint is idempotent when the assessment is already cancelled.
- [Conclude an assessment](https://docs.gominerva.com/api-reference/assessments/conclude-an-assessment.md): Concludes an assessment once required tasks are complete and open questions or confirmations are resolved.
- [Create a risk assessment](https://docs.gominerva.com/api-reference/assessments/create-a-risk-assessment.md): Creates a tenant-scoped draft assessment. Tenant, workspace, and actor fields are derived from the application key.
- [Get a risk assessment](https://docs.gominerva.com/api-reference/assessments/get-a-risk-assessment.md): Returns the full persisted assessment document, including subjects, tasks, evidence, risks, notes, and conclusion state.
- [Get assessment summary](https://docs.gominerva.com/api-reference/assessments/get-assessment-summary.md): Returns compact assessment status, subjects, task counts, client risk rating counts, notes, conclusion, latest run, and timestamps.
- [Get assessment tasks, notes, and interrupts](https://docs.gominerva.com/api-reference/assessments/get-assessment-tasks-notes-and-interrupts.md): Returns task records, task status counts, notes, open or answered questions, confirmations, and client risk ratings.
- [List risk assessments](https://docs.gominerva.com/api-reference/assessments/list-risk-assessments.md): Lists risk assessments for the application tenant with status, task status, search, and pagination filters.
- [Start an assessment agent run](https://docs.gominerva.com/api-reference/assessments/start-an-assessment-agent-run.md): Starts the assessment by creating an agent-runtime run owned by risk-assessment-svc.
- [Stop an assessment and cancel the latest run](https://docs.gominerva.com/api-reference/assessments/stop-an-assessment-and-cancel-the-latest-run.md): Cancels the latest run, or the supplied run_id, when it belongs to this assessment, then marks the assessment cancelled with an audit comment.
- [Update assessment title](https://docs.gominerva.com/api-reference/assessments/update-assessment-title.md): Updates reviewer-visible assessment title metadata.
- [Automatic Disposition Guide](https://docs.gominerva.com/api-reference/automatic-disposition-guide.md): How to consume Automatic Disposition outputs - review_status, automatic_disposition, and disposition_hint - in Direct API screening integrations.
- [List assessment and task statuses](https://docs.gominerva.com/api-reference/configuration/list-assessment-and-task-statuses.md): Returns built-in and tenant custom status definitions for assessment and task state rendering.
- [List client risk rating scorecards](https://docs.gominerva.com/api-reference/configuration/list-client-risk-rating-scorecards.md): Lists tenant and workspace scoped client risk rating scorecards used by workflows and assessments.
- [List risk assessment workflows](https://docs.gominerva.com/api-reference/configuration/list-risk-assessment-workflows.md): Lists active, draft, or archived workflows available to the authenticated application tenant. Tenant and workspace are derived from the application key.
- [Introduction](https://docs.gominerva.com/api-reference/introduction.md): An introduction to the Minerva API and its capabilities
- [Single Search Synchronous API (GET)](https://docs.gominerva.com/api-reference/legacy/single-search-synchronous-api-get.md): Legacy synchronous single search via query parameters. This GET method is retained for backwards compatibility and simple name-only requests. For new integrations, use the canonical POST /v1/search-sync method, especially when supplying address, date of birth, or personal ID fields. Average completi…
- [Minerva MCP](https://docs.gominerva.com/api-reference/minerva-mcp-guide.md): How to reach Minerva from coding agents over the hosted MCP server, including per-harness setup, personal access tokens, scopes, and admin enablement.
- [Update Potential Match Status](https://docs.gominerva.com/api-reference/potential-matches/update-potential-match-status.md): Updates the review status of a potential match returned by a search. Use this endpoint after an analyst or downstream workflow has reviewed a search result and needs to record the disposition.
- [Profile Groups API](https://docs.gominerva.com/api-reference/profile-groups.md): Create and manage workspace-scoped profile groups for dynamic profile segmentation.
- [Add Profile Comment](https://docs.gominerva.com/api-reference/profile-management/add-profile-comment.md): Adds a comment to a screening profile. Comments are useful for recording analyst rationale, follow-up notes, and review context alongside the profile record.
- [Archive Profile Group](https://docs.gominerva.com/api-reference/profile-management/archive-profile-group.md): Archive a profile group. This is a soft delete: existing profile records keep their stored group IDs, but archived groups are excluded from active profile group lists unless requested.
- [Create Profile](https://docs.gominerva.com/api-reference/profile-management/create-profile.md): The **POST** method on the resource group can be used to create a new profile without performing any initial screening. This method can be helpful for migrations or for synchronizing new profile creation from an admin system to the Minerva tenant profiles.
- [Create Profile Group](https://docs.gominerva.com/api-reference/profile-management/create-profile-group.md): Create a workspace-scoped profile group for dynamic customer segmentation. The API key determines the tenant and workspace; profile group IDs and keys are generated by Minerva.
- [Create Profile (Onboarding)](https://docs.gominerva.com/api-reference/profile-management/create-profile-onboarding.md): The **POST** method on the resource group can be used to create a new profile while performing screening on that profile at the same time. This method allows for the creation of profiles with potential onboarding review tasks, and immediate enrolment into ongoing monitoring.
- [Generate profile audit PDF](https://docs.gominerva.com/api-reference/profile-management/generate-profile-audit-pdf.md): Returns a PDF audit export for the specified screening profile. Provide the profile ID in the path and omit the request body. Minerva generates the report from stored records, including profile details, screening history, retained match evidence, analyst comments, and the authenticated application t…
- [Get Profile Details](https://docs.gominerva.com/api-reference/profile-management/get-profile-details.md): The **GET** method on a single profile resource will return the details for a single profile by its ID.
- [Get Profile Group](https://docs.gominerva.com/api-reference/profile-management/get-profile-group.md): Retrieve one workspace-scoped profile group by its Minerva-generated ID.
- [List Profile Groups](https://docs.gominerva.com/api-reference/profile-management/list-profile-groups.md): List workspace-scoped profile groups available to the application API key. By default, archived groups are excluded.
- [List profiles](https://docs.gominerva.com/api-reference/profile-management/list-profiles.md): The **GET** method on the resource group will list profiles that have been previously created in the tenant of the requester. This can be used to extract a list of profiles and sync them back to an internal system, or to build integrations with internal systems to fetch profiles according to certain…
- [Update Profile](https://docs.gominerva.com/api-reference/profile-management/update-profile.md): The **PATCH** method on a single profile resource will update fields on that profile.
- [Update Profile Group](https://docs.gominerva.com/api-reference/profile-management/update-profile-group.md): Update profile group labels, priority, archived status, or monitoring frequency overrides. The profile group key cannot be supplied or changed through the public API.
- [Create a canvas](https://docs.gominerva.com/api-reference/relationships-canvas/create-a-canvas.md): Creates a blank or subject-graph canvas for the assessment.
- [Delete a canvas](https://docs.gominerva.com/api-reference/relationships-canvas/delete-a-canvas.md): Deletes a canvas after optimistic version checking.
- [Get a canvas by id](https://docs.gominerva.com/api-reference/relationships-canvas/get-a-canvas-by-id.md): Returns a canvas by id after verifying it belongs to the requested assessment and application tenant.
- [Get or create the default canvas](https://docs.gominerva.com/api-reference/relationships-canvas/get-or-create-the-default-canvas.md): Returns the default assessment canvas, creating one from the subject graph template when none exists.
- [List assessment canvases](https://docs.gominerva.com/api-reference/relationships-canvas/list-assessment-canvases.md): Lists all canvases attached to the assessment.
- [Rename a canvas](https://docs.gominerva.com/api-reference/relationships-canvas/rename-a-canvas.md): Renames a canvas with optimistic version checking.
- [Save a canvas by id](https://docs.gominerva.com/api-reference/relationships-canvas/save-a-canvas-by-id.md): Replaces a canvas state by id with optimistic version checking.
- [Save the default canvas](https://docs.gominerva.com/api-reference/relationships-canvas/save-the-default-canvas.md): Replaces the default canvas state. Version mismatches return 409 so clients can reload before overwriting another editor's work.
- [Add an assessment comment](https://docs.gominerva.com/api-reference/review-and-collaboration/add-an-assessment-comment.md): Adds a general or object-scoped comment to the assessment audit trail. created_by is derived from the application key.
- [Answer an agent question](https://docs.gominerva.com/api-reference/review-and-collaboration/answer-an-agent-question.md): Answers an open assessment question and lets the run continue once the runtime processes the corresponding command.
- [Append assessment notes](https://docs.gominerva.com/api-reference/review-and-collaboration/append-assessment-notes.md): Appends markdown to assessment notes using optimistic concurrency through expected_version.
- [List assessment comments](https://docs.gominerva.com/api-reference/review-and-collaboration/list-assessment-comments.md): Lists assessment, task, CRR, or canvas comments. Query filters can be combined for specific subjects, criteria, canvases, or event kinds.
- [Replace assessment notes](https://docs.gominerva.com/api-reference/review-and-collaboration/replace-assessment-notes.md): Replaces assessment notes using optimistic concurrency through expected_version.
- [Resolve an agent confirmation](https://docs.gominerva.com/api-reference/review-and-collaboration/resolve-an-agent-confirmation.md): Resolves a pending confirmation request produced by the agent.
- [Update task details](https://docs.gominerva.com/api-reference/review-and-collaboration/update-task-details.md): Updates task context, evidence ids, resolution fields, and optional status.
- [Update task status](https://docs.gominerva.com/api-reference/review-and-collaboration/update-task-status.md): Manually updates a task status and records a status-update comment. Terminal task statuses require comment_markdown explaining the customer-facing rationale.
- [Risk Assessment Agents API](https://docs.gominerva.com/api-reference/risk-assessment-agents.md): How to create, run, review, and collaborate on beta agent risk assessments through the Minerva API.
- [Screening Integration Guide](https://docs.gominerva.com/api-reference/screening-integration-guide.md): Map Minerva screening responses into compliance review workflows, interpret risk flags and match scores, and retrieve profile-linked search results.
- [Create screening webhook](https://docs.gominerva.com/api-reference/screening-webhooks/create-screening-webhook.md): The **POST** method on the resource group can be used to create a new screening webhook. This will automatically generate a webhook key and unique ID for the new webhook. The response payload will contain both the unique ID and the newly generated webhook key which should be stored in a vault or sec…
- [Delete screening webhook](https://docs.gominerva.com/api-reference/screening-webhooks/delete-screening-webhook.md): The **DELETE** method on a single screening webhook resource will delete the webhook with that ID permanently. This will deactivate the webhook and remove it from the list of subscribed webhooks in the tenant and the target server/url will no longer receive notifications from the webhook. This metho…
- [Get screening webhook](https://docs.gominerva.com/api-reference/screening-webhooks/get-screening-webhook.md): The **GET** method on a single screening webhook resource will return the details for a single screening webhook by its ID.
- [List screening webhooks](https://docs.gominerva.com/api-reference/screening-webhooks/list-screening-webhooks.md): The **GET** method on the resource group will list screening webhooks that have been previously created in the tenant of the requester. This can be used to extract a list of screening webhooks to review the current webhooks that are in place for the tenant for reference or cleanup purposes.
- [Test screening webhook](https://docs.gominerva.com/api-reference/screening-webhooks/test-screening-webhook.md): The **POST** method on the screening webhook test path will trigger a simulated payload to the destination URL with the webhook key in the "x-webhook-key" header. The header and payload will have the same structure as the payload in production, so it is possible to use the webhook test endpoint duri…
- [Update screening webhook](https://docs.gominerva.com/api-reference/screening-webhooks/update-screening-webhook.md): The **PATCH** method on a single screening webhook resource will update fields on that screening webhook.
- [Search History](https://docs.gominerva.com/api-reference/search-history.md): Retrieve historical Minerva screening requests for audit and reconciliation workflows.
- [Batch Asynchronous Search API](https://docs.gominerva.com/api-reference/search/batch-asynchronous-search-api.md): **"I want to submit a batch of multiple searches at once to Minerva in an asynchronous way so that I can query the long running job later."**
- [Batch Search Results API](https://docs.gominerva.com/api-reference/search/batch-search-results-api.md): I submitted an asynchronous search request and got a job ID. Now I want to check the job status and get the results of the batch if the screening is done. On successful submission of a response to the search endpoint, a job id will be returned. Use this job id to query the status of your search. If…
- [Generate PDF Report](https://docs.gominerva.com/api-reference/search/generate-pdf-report.md): Generate PDF reports as evidence that screening in Minerva was completed. The recommended workflow is to pass a single `searchResultId` from a previous `POST /v1/search-sync` response or from a batch result returned by `POST /v1/searchStatus` or `GET /v1/search/{jobid}`. For batch results, use the e…
- [List historical search requests](https://docs.gominerva.com/api-reference/search/list-historical-search-requests.md): Returns paginated historical screening/search request metadata for the authenticated tenant. Use this endpoint for audit-purpose search history retrieval when reconciling screenings that were run in Minerva.
- [Single Search Synchronous API](https://docs.gominerva.com/api-reference/search/single-search-synchronous-api.md): Canonical synchronous single search via request body for single individual or entity screening. Use this POST method for new integrations and whenever supplying combinations of PII such as name, address, date of birth, or personal ID fields for security reasons. Average completion time varies - full…
- [SAML SSO and SCIM Guide](https://docs.gominerva.com/authentication-sso-scim-guide.md): How tenant admins configure SAML single sign-on, sign-in modes, and SCIM provisioning in Minerva.
- [Automatic Disposition Guide](https://docs.gominerva.com/automatic-disposition-guide.md): How to configure and review beta automatic disposition predictions for potential screening matches.
- [Bulk Actions Guide](https://docs.gominerva.com/bulk-actions-guide.md): How to use Screening bulk actions for large-scale match and profile updates.
- [Adverse Media](https://docs.gominerva.com/concepts/adverse-media.md): An introduction to adverse media at Minerva
- [Data Feeds](https://docs.gominerva.com/concepts/data-feeds.md): An introduction to Minerva data feeds
- [PEP Policy](https://docs.gominerva.com/concepts/pep-policy.md): Minerva policy for defining, classifying, and retaining politically exposed person data
- [Profile Groups](https://docs.gominerva.com/concepts/profile-groups.md): Workspace-scoped dynamic segmentation for monitored profiles.
- [Risk Rating](https://docs.gominerva.com/concepts/risk-rating.md): An introduction to risk rating with Minerva
- [Sanctions](https://docs.gominerva.com/concepts/sanctions.md): An introduction to sanctions screening with Minerva
- [Custom Lists Guide](https://docs.gominerva.com/custom-lists-guide.md): How to manage tenant-owned screening lists: upload records, publish versions, activate lists per workspace, and control risk rating impact.
- [Dashboards Guide](https://docs.gominerva.com/dashboards-guide.md): How to use Dashboards
- [Exports Guide](https://docs.gominerva.com/exports-guide.md): How to export screening profiles and potential matches for analytics, visibility, and audit workflows.
- [FAQ](https://docs.gominerva.com/faq.md): Frequently asked questions about Minerva results, search behavior, and follow-up steps
- [Introduction](https://docs.gominerva.com/introduction.md): Welcome to the Minerva Knowledge Hub
- [Match Scoring Guide](https://docs.gominerva.com/match-scoring-guide.md): How to configure screening thresholds, candidate scoring weights, matching behavior, News retrieval, entity resolution, and score simulations across Minerva workflows.
- [Minerva App](https://docs.gominerva.com/minerva-app.md): Start here for a guided walkthrough of the Minerva web application
- [Profiles](https://docs.gominerva.com/minerva-profiles.md): Profile review and alert disposition workflows in the Minerva app
- [Reporting](https://docs.gominerva.com/minerva-reporting.md): Management oversight workflows in the Minerva app
- [Risk Assessment](https://docs.gominerva.com/minerva-risk-assessment.md): Deeper due diligence workflows in the Minerva app
- [Profile Groups Guide](https://docs.gominerva.com/profile-groups-guide.md): How to create and use profile groups for dynamic customer segmentation in Screening.
- [Risk Assessment Flow](https://docs.gominerva.com/risk-assessment-flow.md): How to create, review, and export a risk assessment
- [Risk Inference Guide](https://docs.gominerva.com/risk-inference-guide.md): How Minerva derives PEP, Criminal, and High Risk Industry signals from sourced profile text, and how admins can tune the behavior by screening channel.
- [Role-Aware Adverse Media Guide](https://docs.gominerva.com/role-aware-adverse-media-guide.md): How to configure role-aware adverse media labels and filtering across Minerva screening workflows.
- [Screening Frequencies Guide](https://docs.gominerva.com/screening-frequencies-guide.md): How to configure ongoing monitoring cadence caps, workspace defaults, and profile group overrides.
- [Screening Guide](https://docs.gominerva.com/screening-guide.md): How to use Screening
- [Training Videos](https://docs.gominerva.com/training-videos.md): Watch Minerva training videos and walkthroughs from one place
- [Workspaces Guide](https://docs.gominerva.com/workspaces-guide.md): How Live and Calibration workspaces isolate Minerva configuration, presets, and promotion workflows.

## OpenAPI Specs

- [profiles](https://docs.gominerva.com/api-reference/profiles.json)
- [clm-svc](https://docs.gominerva.com/api-reference/clm-svc.json)
- [core](https://docs.gominerva.com/api-reference/core.json)
- [risk-assessment-agents](https://docs.gominerva.com/api-reference/risk-assessment-agents.json)
- [openapi2](https://docs.gominerva.com/api-reference/openapi2.json)
- [admin-api](https://docs.gominerva.com/api-reference/admin-api.json)
- [openapi](https://docs.gominerva.com/api-reference/openapi.json)

## Optional

- [Support](mailto:support@gominerva.com)
- [Trust Page](https://app.conveyor.com/profile/gominerva)