Getting Access
Access to the Minerva API is managed through the Minerva dashboard:- API keys are created and managed from Administration > Developers. This page requires the Developer role or above.
- Create separate live and dev applications so each integration has its own key lifecycle, usage history, and owner context.
- For additional access or integration requests, please contact support@gominerva.com.
- Application API keys are not scoped by per-key RBAC permissions. Any application key carries the full API access of the tenant and workspace context it was created in, so isolate integrations by creating separate applications rather than by narrowing a key.
- Hosted MCP credentials are the exception: personal access tokens and agent authorizations issued for the Minerva MCP server do carry an explicit per-token scope list. Those scopes apply to the MCP endpoints only and never widen or narrow an application API key.
Authentication Schemes
Minerva accepts three credential formats. Which one applies depends on the surface you are calling.API Overview
The Minerva API is organized around two key capabilities:- Profile Management
- Real-Time Risk Assessment
1. Profile Management & Monitoring
- Integrate Minerva into onboarding workflows to screen and register customers in a single step.
- Keep customer profiles up to date and synchronize data across internal systems and Minerva.
- Enable ongoing monitoring for changes in risk status or new matches.
- Leverage APIs and webhooks to support investigation workflows, review queues, and keep internal systems in sync
2. Real-Time Risk Assessment
Minerva screens individuals and entities against global watchlists (e.g. sanctions, PEPs, criminal, terror lists) and adverse media mentions. Results are enriched with supporting evidence and confidence scoring.- Real-Time Screening: Instantly screen a single profile synchronously for immediate results.
- Batch Screening: Submit large batches of profiles to be processed in parallel asynchronously, supporting high-volume operations.
- Generate reports: Automatically summarize search results and profile data for documentation, audits, or compliance filings.
Interpreting Screening Results
Each object in a search response’sresults[] array is a ranked potential
match. It is evidence for review, not a confirmed identity match or an
automatic compliance conclusion.
Use three separate questions when mapping the response into a compliance
workflow:
Field-level and alias-level scores describe the one value they sit on. Each name
in
aliases[] carries its own match_score and criteria_match_level for that
alias alone, so scores in one array normally differ and a record can hold one
exact alias beside several that score none. The closest-matching alias
carries matched_query: true when it also scored above the candidate’s primary
name. It marks the one name that matched the search best. An alias that scores
above the primary name but below another alias does not carry it. Read overall
match strength from score and match_score_info.
High-Level Sanctions Example
The following abbreviated example shows the fields an integration normally uses first. The values are illustrative.checklist.screen.Sanctions: trueis the direct risk indicator.score: 0.94says the candidate is a strong overall criteria match.checklist.hits.Sanctionsidentifies the list that triggered the flag.checklist.hits_info[]shows that the name is close and the reported date is exact.source_details[]provides the source description, URLs when available, and any supporting inference context.
See the Screening Integration
Guide for the complete response
hierarchy, Sanctions/PEP/News mappings, score and closeness interpretation,
consensus and source-lineage fields, profile-linked search history, and
recommended analyst review order.
Recommended Report Generation Flow
UsePOST /v1/reports with a searchResultId from a previous search.
The abbreviated responses below only show the fields you need to carry from
one step to the next:
jobid, searchId, searchResultId, index, and
reports.Single Search Flow
Step 1: RunPOST /v1/search-sync
Request:
POST /v1/reports with that searchId
Request:
index selects the ranked match from the prior search response: 0 for the
top match, 1 for the second match, and so on.Batch Search Flow
Step 1: RunPOST /v1/search
Request:
POST /v1/searchStatus or GET /v1/search/{jobid}. The
examples below use POST /v1/searchStatus.
Request:
POST /v1/reports with the batch result searchId
Request:
Summary
With Minerva’s API’s you can:- Screen individuals and entities in real time or as part of a batch
- Integrate screening and monitoring into onboarding and compliance workflows
- Monitor and manage customer profiles over time
- Generate audit-ready reports for documentation and regulatory filings
- Streamline and scale your AML compliance operations