# Minerva Docs

## Docs

- [Alert Suppression Guide](https://docs.gominerva.com/alert-suppression-guide.md): How to configure screening alert suppression for monitored profiles and ongoing screening.
- [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."**
- [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…
- [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 (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.
- [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.
- [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.
- [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.
- [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…
- [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…
- [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
- [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
- [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 match thresholds and news geography bias 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
- [Risk Assessment Flow](https://docs.gominerva.com/risk-assessment-flow.md): How to create, review, and export a risk assessment
- [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

## OpenAPI Specs

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

## Optional

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