> ## Documentation Index > Fetch the complete documentation index at: https://docs.gominerva.com/llms.txt > Use this file to discover all available pages before exploring further. # Single Search Synchronous API (GET) > 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 completion time varies - full EDD search completes within 45 seconds, Sanctions and PEP searches typically complete in 300ms-3 seconds. All parameters are matched softly using the Minerva scoring algorithm. ## OpenAPI ````yaml /api-reference/core.json get /v1/search-sync openapi: 3.0.0 info: version: 1.6.2 title: MinervaAI Core API description: >- The MinervaAI core monolith that serves the search, consensus, pruning, and report generation capabilities. servers: - url: https://api.gominerva.com description: The production API server for Minerva AI security: - ApiKeyAuth: [] tags: - name: Search description: >- Current screening, search, and reporting endpoints for active integrations. - name: Legacy description: >- Legacy endpoints retained for backwards compatibility. Prefer the canonical POST-based search flows for new integrations. - name: API to UI Integration description: Endpoints used to bridge API integrations with Minerva UI workflows. - name: Potential Matches description: Update review workflow state for potential matches returned by searches. paths: /v1/search-sync: get: tags: - Legacy summary: Single Search Synchronous API (GET) description: >- 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 completion time varies - full EDD search completes within 45 seconds, Sanctions and PEP searches typically complete in 300ms-3 seconds. All parameters are matched softly using the Minerva scoring algorithm. parameters: - name: type in: query required: true description: >- The type of profile to search for. Should be "individual" or "organization". schema: type: string enum: - individual - organization example: individual - name: name in: query required: true description: The full legal name of the search subject. schema: type: string example: John Smith - name: feeds in: query required: true description: >- A comma-separated array of feeds to include in the scope of the search. Must be selected from "Sanctions", "PEP", "Criminal", "Legal", "Offshore", "Open Source", "Ownership", "News", "Registries", "Social Media", or "all". Use "all" to select all available feeds. schema: type: string example: Sanctions,PEP,News - name: gender in: query description: >- The gender of the individual. Only applicable for individual type searches. Matched softly. schema: type: string example: Male - name: year in: query description: >- The full year integer describing when the individual was born, or that the organization was founded. schema: type: integer example: 1970 - name: month in: query description: >- The month integer describing when the individual was born, or that the organization was founded. Corresponds to calendar month integers (1 = January). schema: type: integer minimum: 1 maximum: 12 example: 6 - name: day in: query description: >- The calendar day integer describing when the individual was born, or that the organization was founded. schema: type: integer minimum: 1 maximum: 31 example: 11 - name: city in: query description: The currently known town, city, or municipality of the profile. schema: type: string example: Toronto - name: state in: query description: The currently known state or province of the profile. schema: type: string example: Ontario - name: country in: query description: The currently known country or nationality of the profile. schema: type: string example: Canada - name: occupation in: query description: >- The current job title or role of the individual. Only applicable for individual type searches. schema: type: string example: Software Developer - name: organization in: query description: >- The current organization that the individual is associated with. Only applicable for individual type searches. schema: type: string example: Minerva - name: notes in: query description: Additional notes or information to narrow the results. schema: type: string example: 'Personal website: www.johnsmith.com' - name: externalId in: query description: External identifier for tracking purposes. schema: type: string example: '12345678' - name: address in: query description: >- The currently known address of the profile. Can include lines 1 and 2 in a single line. schema: type: string - name: phone in: query description: >- A E.164 compliant international phone number string associated with the profile. schema: type: string - name: email in: query description: A known email address associated with the profile. schema: type: string - name: regID in: query description: >- The registration ID of the organization. Only applicable for organization type searches. schema: type: string - name: match_threshold in: query description: >- Custom match threshold on the profile match score, below which results will not be returned. schema: type: number - name: max_lookback_days in: query description: >- Applies a max window on time in days for supported feeds. Currently only supported on the "News" feed for adverse media. schema: type: number - name: soft_match in: query description: >- Determines whether or not to use soft match. All parameters are matched softly using the Minerva scoring algorithm. schema: type: boolean - name: location_match_strictness in: query description: >- Applies a hard exclusion for any data points that do not match the geography at the specified resolution. Allowed values are "city", "state", and "country". schema: type: string enum: - city - state - country - name: omit_open_source in: query description: >- Determines whether or not to omit the open source feed for certain feeds that automatically include open source (e.g., PEP). schema: type: boolean responses: '200': description: >- Search successfully completed. Returns the search results synchronously. content: application/json: schema: type: object properties: status: type: integer example: 200 message: type: string example: Search successfully completed. jobid: type: string example: adf48860-6a96-43a4-b008-37eccd139e3a duration: type: number description: Elapsed execution time in seconds. example: 1.23 searchId: type: string description: >- Search result identifier. Pass this value as `searchResultId` when generating a report with `POST /v1/reports`. example: 69ba0b732908cb3209647d36 pending: type: boolean description: Whether the synchronous search still has pending work. example: false dashboardViewLink: type: string example: >- https://app.gominerva.com/dashboard?requestId=REQUEST_ID&jobId=JOB_ID#results request: $ref: '#/components/schemas/SearchRequest' results: type: array description: >- Up to 10 potential matches ranked by criteria match score. Each result is a Profile object containing rich profile information with source lineage. items: $ref: '#/components/schemas/Profile' '400': description: >- Returns a 400 error when there is an issue with the input parameters or field formatting. content: application/json: schema: type: object properties: status: type: integer example: 400 message: type: string example: Empty or invalid parameters '403': description: >- Returns a 403 error when authentication headers are missing or invalid. content: application/json: schema: type: object properties: status: type: integer example: 403 message: type: string example: Missing x-api-key header. '405': description: >- Returns a 405 error when secure fields like SSN or personalID are included in GET requests. content: application/json: schema: type: object properties: status: type: integer example: 405 message: type: string example: Secure fields are not allowed in GET requests. deprecated: true security: - ApiKeyAuth: [] components: schemas: SearchRequest: type: object properties: type: enum: - Individual - Organization type: string description: >- The type of search that is being requested. When requesting for an individual search vs an organization search, there are some different fields that are specific to each type that will be considered. Different data sources will be considered as well for individuals vs organizations. example: Individual name: type: string example: John Smith description: >- The full legal name of the individual or organization, including any middle names. gender: type: string enum: - Male - Female - Other description: >- The gender of the individual. Only applicable for individual type searches. Matched softly against the database. example: Male year: type: number example: 1970 description: >- The year that the individual was born, or the organization was created. month: type: number minimum: 1 maximum: 12 example: 6 description: >- The month that the individual was born, or the organization was created. day: type: number minimum: 1 maximum: 31 example: 11 description: >- The day that the individual was born, or the organization was created. city: type: string example: Toronto description: >- The last known city that the individual or organization was known to operate in. Results from nearby cities may be returned if other criteria match strongly. state: type: string example: Ontario description: >- The last known state or province that the individual or organization was known to operate in. This should be the full state name, such as "New York". country: type: string example: Canada description: >- The known nationality or the last known country that the individual or organization was known to operate in. This should be a canonical full country name, such as "United States" or "United Kingdom". Values will be normalized such that "United States" will match "US" and "United States of America". occupation: type: string example: Software Developer description: >- The last known job title or occupation. This query parameter will only be considered for Individual type searches. organization: type: string example: MinervaAI description: >- The last known employer or the organization that the individual is a member of. This query parameter will only be considered for Individual type searches. email: type: string example: john.smith@gmail.com description: The known email address of the individual or organization. phone: type: string example: '+15555555555' description: The known phone number of the individual or organization. personalID: type: string example: A1234-BCDEF-GHIJK description: >- For individual searches, any personal ID numbers such as a driver's license, passport number, or national ID. regID: type: string example: '19288709' description: >- For entity searches, any entity ID numbers such as a registration number. notes: type: string example: 'Personal website: www.johnsmith.com' description: >- Additional unstructured notes that can be provided to potentially narrow the search further using semantic cues and soft matching. externalId: type: string example: '12345678' description: >- External identifier for tracking purposes. A custom tag that can be assigned to the screen, which will be stored with the job request data when queried in the future. global_filters: $ref: '#/components/schemas/GlobalFilters' description: >- Global filtering options that apply to all feeds in the search request. feed_filters: $ref: '#/components/schemas/FeedFilters' description: >- Feed-specific filtering options that override global filters for individual feeds. custom_id: type: string example: customer_01 description: >- A custom tag that can be assigned to the screen, which will be stored with the job request data when queried in the future. required: - type - name Profile: type: object description: >- MinervaAI data schema describing the screening results for a single profile. Contains rich information with source lineage for entity resolution and compliance screening. properties: type: type: integer enum: - 0 - 1 description: The type of profile. 0 for individual, 1 for organization. example: 0 name: $ref: '#/components/schemas/SourcedName' description: The primary name of the profile with source lineage. last_updated: type: string description: String timestamp of when the profile was last updated. example: Saturday, Jun 26 2021 - 03:05:55 GMT00:00 merge_id: type: string description: The unique ID of this profile in the knowledge graph. example: merge_abc123 pep_level: type: integer minimum: 1 maximum: 4 description: PEP inference tier from 1-4, where 1 is highest risk. example: 2 aliases: type: array description: >- Other known names for the profile, including names in non-Latin character sets. items: $ref: '#/components/schemas/SourcedName' gender: $ref: '#/components/schemas/SourcedGender' description: >- The gender of the profile. Only present for individual type profiles. company_type: $ref: '#/components/schemas/SourcedString' description: The type of company. Only present for organization type profiles. industry: $ref: '#/components/schemas/SourcedString' description: The industry of the profile. company_size: $ref: '#/components/schemas/SourcedString' description: >- The size of the company. Only present for organization type profiles. status: $ref: '#/components/schemas/SourcedString' description: >- The current status of the profile. For corporations, indicates company status such as "active" or "dissolved". occupation: $ref: '#/components/schemas/SourcedString' description: >- The job title or position of the individual. Only present for individual type profiles. organization: $ref: '#/components/schemas/SourcedString' description: >- The employer, affiliated entity, political party, or other organization associated with the individual. Only present for individual type profiles. nationality: $ref: '#/components/schemas/SourcedString' description: >- The known nationality or affiliated country of the profile. Contains the full country name. time_begin: $ref: '#/components/schemas/SourcedDate' description: >- The date of birth of the individual, or the date of incorporation/date active of the organization. time_end: $ref: '#/components/schemas/SourcedDate' description: >- If known/applicable, the date deceased of the individual or date of closure of the organization. alt_times: type: array description: Other known dates of birth or incorporation for the profile. items: $ref: '#/components/schemas/SourcedDate' place_of_birth: $ref: '#/components/schemas/SourcedString' description: >- The place of birth of the individual. May contain city, state, and/or country. contact: $ref: '#/components/schemas/ProfileContact' description: Contact information including email and phone. media: $ref: '#/components/schemas/ProfileMedia' description: >- Media-related information including adverse/neutral media URLs and social media usernames. Present when News, Open Source, or Social Media feeds are included. locations: type: array description: >- Locations associated with the profile such as addresses, cities, or countries. items: $ref: '#/components/schemas/SourcedString' images: type: array description: Images associated with the profile. items: $ref: '#/components/schemas/SourcedString' other_fields: type: object description: Miscellaneous fields that do not fit within other defined fields. additionalProperties: $ref: '#/components/schemas/SourcedString' links: type: array description: >- Individuals, entities, or concepts linked to the profile. Includes family relationships (Father, Brother), ownership records (Director, Shareholder), and employee records (Chief Financial Officer). items: $ref: '#/components/schemas/SourcedAffiliation' ID: type: object description: >- Identity-associated fields such as passport numbers, driver's licenses, national IDs. additionalProperties: $ref: '#/components/schemas/SourcedString' documents: type: array description: >- References to digital documents discovered for this profile. May include corporate registry listings, court/legal documents, public securities filings (SEC), or open source investigation files. items: $ref: '#/components/schemas/UrlInfo' websites: type: array description: >- Websites that are owned by or describe this profile, including corporate websites, personal websites, and blogs. items: $ref: '#/components/schemas/SourcedString' notes: type: array description: Other unstructured transcripts associated with the profile. items: $ref: '#/components/schemas/SourcedString' checklist: $ref: '#/components/schemas/ProfileChecklist' description: >- Watchlist and risk screening states and sources. Contains hit status for each risk feed and detailed breakdown of hits. client_risk_rating: $ref: '#/components/schemas/ClientRiskRating' description: >- Customer Risk Rating (CRR) assessment based on discovered data. Provides overall risk score and contributing factors. sources: type: array description: List of source names that contributed data to this profile. items: type: string example: - OFAC SDN List - World Leaders Database - Reuters source_details: type: array description: >- Details and metadata associated with the sources that contributed data to this profile. items: $ref: '#/components/schemas/SourceDetailElement' score: type: number minimum: 0 maximum: 1 description: >- The Criteria Match Score - a normalized value between 0 and 1 representing the match percentage to the search parameters. 1.0 = exact match, 0.8-0.99 = partial match, < 0.79 = low confidence match. example: 0.95 match_score_info: $ref: '#/components/schemas/MatchScoreInfo' description: >- Detailed breakdown of the Criteria Match Score for each field provided in the search parameters. review_status: type: string enum: - not_found - unresolved - true_positive - false_positive - suppressed description: The review status of the profile if it has been reviewed. example: unresolved reportURL: type: string description: >- URL to the generated PDF report for this profile, if one has been generated. example: https://storage.googleapis.com/... required: - type - name - sources - source_details GlobalFilters: type: object description: Global filtering options that apply to all feeds in the search request. properties: location_match_strictness: type: string enum: - city - state - country description: >- Applies a hard exclusion for any data points that do not match the geography at the specified resolution. example: city match_threshold: type: number minimum: 0 maximum: 1 description: >- Custom match threshold on the profile match score, below which results will not be returned. Default is 0.7 (70% match). example: 0.8 soft_match: type: boolean description: >- Determines whether to use soft matching. All parameters are matched softly using the Minerva scoring algorithm, meaning searches for "Male" gender may not exclude "Female" results if other criteria match strongly enough. example: true FeedFilters: type: object description: >- Feed-specific filtering options that override global filters for individual feeds. additionalProperties: type: object properties: location_match_strictness: type: string enum: - city - state - country description: Feed-specific location match strictness override. example: state soft_match: type: boolean description: Feed-specific soft match override. example: true match_threshold: type: number minimum: 0 maximum: 1 description: Feed-specific match threshold override. example: 0.8 example: Sanctions: location_match_strictness: country soft_match: true match_threshold: 0.9 SourcedName: type: object description: >- MinervaAI data schema describing a name for an individual or organization, with structured first/last name components and source lineage. properties: value: type: string description: >- The last name (for individuals) or full company name (for organizations). example: Smith first: $ref: '#/components/schemas/SourcedString' description: For individuals only, the first name with source lineage. other_names: type: array description: Middle names, initials, prefixes, and suffixes. items: $ref: '#/components/schemas/SourcedString' sources: type: array description: Source lineage for the last name or full company name. items: $ref: '#/components/schemas/SourcedStringSource' inferred: type: boolean description: >- Indicates whether the value was inferred algorithmically (true) or reported directly from the source. example: false reputation_score: type: integer minimum: 0 maximum: 10 description: Score from 0-10 indicating the reputation of the source. example: 8 trusted: type: boolean description: >- Reports whether the reputation score is at or above the threshold for trusted status. example: true match_score: type: number minimum: 0 maximum: 1 description: >- Score from 0.0-1.0 indicating the closeness of the match between the search criteria and this name. example: 0.98 criteria_match_level: $ref: '#/components/schemas/CriteriaMatchLevel' description: Label associated with the match score. required: - value SourcedGender: type: object description: >- A sourced gender object containing the gender value and source lineage. Gender is normalized to "Male", "Female", "Other", or "Unknown". properties: value: type: string description: The gender value, normalized to Male, Female, Other, or Unknown. enum: - Male - Female - Other - Unknown example: Male sources: type: array description: Array of source lineage objects for this gender field. items: $ref: '#/components/schemas/SourcedStringSource' inferred: type: boolean description: >- Indicates whether the value was inferred algorithmically (true) or reported directly from the source. example: false reputation_score: type: integer minimum: 0 maximum: 10 description: Score from 0-10 indicating the reputation of the source. example: 7 trusted: type: boolean description: >- Reports whether the reputation score is at or above the threshold for trusted status. example: true match_score: type: number minimum: 0 maximum: 1 description: >- Score from 0.0-1.0 indicating the closeness of the match between the search criteria and this gender value. example: 1 criteria_match_level: $ref: '#/components/schemas/CriteriaMatchLevel' description: Label associated with the match score. required: - value SourcedString: type: object description: >- A sourced string object containing a consensus value and source lineage. Minerva applies Entity Resolution to consolidate data from diverse sources, preserving the original source values and scores in the lineage. properties: value: type: string description: >- The consensus value that best represents the combination of source values discovered during the automated investigation. example: Software Engineer sources: type: array description: >- Array of source lineage objects containing information about each source that reported data for this field. items: $ref: '#/components/schemas/SourcedStringSource' timestamp: $ref: '#/components/schemas/DateObject' description: The timestamp associated with the data. inferred: type: boolean description: >- Indicates whether the value was inferred algorithmically (true) or reported directly from the source. example: false reputation_score: type: integer minimum: 0 maximum: 10 description: >- Score from 0-10 indicating the general reputation and trustworthiness of the consensus value. A value of 7 or above indicates "trusted" status. example: 8 trusted: type: boolean description: >- Indicates whether the information is likely to be a ground truth, trusted value. True if reputation_score is 7 or above. example: true match_score: type: number minimum: 0 maximum: 1 description: >- Score from 0.0-1.0 indicating the closeness of the match between the search criteria and this field value. example: 0.95 criteria_match_level: $ref: '#/components/schemas/CriteriaMatchLevel' description: Label associated with the match score. tag: type: string description: >- Additional label to assign the sourced string such as a social media platform. example: LinkedIn required: - value SourcedDate: type: object description: >- A sourced date object containing a consensus date value and source lineage for dates like date of birth or date of incorporation. properties: value: $ref: '#/components/schemas/DateObject' description: The consensus date value. sources: type: array description: Array of source lineage objects for this date field. items: $ref: '#/components/schemas/SourcedDateSource' inferred: type: boolean description: >- Indicates whether the value was inferred algorithmically (true) or reported directly from the source. example: false reputation_score: type: integer minimum: 0 maximum: 10 description: >- Score from 0-10 indicating the general reputation and trustworthiness of the consensus value. example: 9 trusted: type: boolean description: >- Indicates whether the information is likely to be a ground truth, trusted value. example: true match_score: type: number minimum: 0 maximum: 1 description: >- Score from 0.0-1.0 indicating the closeness of the match between the search criteria and this date value. example: 1 criteria_match_level: $ref: '#/components/schemas/CriteriaMatchLevel' description: Label associated with the match score. required: - value ProfileContact: type: object description: >- Contact information for the profile including email addresses and phone numbers. properties: email: type: array description: List of email addresses known for this profile. items: $ref: '#/components/schemas/SourcedString' phone: type: array description: >- List of phone numbers known for this profile. Not guaranteed to be in E.164 format. items: $ref: '#/components/schemas/SourcedString' ProfileMedia: type: object description: >- Media-related information for the profile including adverse and neutral media URLs and social media accounts. Present when News, Open Source, or Social Media feeds are included. properties: risk_urls: type: array description: >- URLs determined to contain relevant AML/financial crimes risk. Articles sorted here are both negative in sentiment and associated with one or more of the 28 financial crimes risk categories. items: $ref: '#/components/schemas/UrlInfo' neutral_urls: type: array description: >- URLs determined to not contain relevant AML/financial crimes risk. Articles sorted here are not negative in sentiment and not associated with financial crimes risk categories. items: $ref: '#/components/schemas/UrlInfo' usernames: type: array description: >- Social media accounts that the deep learning investigation model determined to be associated with this profile. Present when Open Source or Social Media feeds are included. items: $ref: '#/components/schemas/ProfileSocialUsername' SourcedAffiliation: type: object description: >- Screening data schema describing an individual, organization, or concept that is affiliated or linked to a profile. Used for relationships like family connections, ownership records, or employee records. properties: value: type: string description: >- The subject that this affiliation describes, such as a person, organization, or concept. example: Acme Corporation type: $ref: '#/components/schemas/SourcedString' description: >- The way that the source is affiliated with the subject, such as "Father", "Shareholder", or "Chief Financial Officer". sources: type: array description: Source lineage for the affiliation. items: $ref: '#/components/schemas/SourcedStringSource' inferred: type: boolean description: >- Indicates whether the value was inferred algorithmically (true) or reported directly from the source. example: false reputation_score: type: integer minimum: 0 maximum: 10 description: Score from 0-10 indicating the reputation of the source. example: 8 trusted: type: boolean description: >- Reports whether the reputation score is at or above the threshold for trusted status. example: true match_score: type: number minimum: 0 maximum: 1 description: >- Score from 0.0-1.0 indicating the closeness of the match between the search criteria and this affiliation. example: 0.85 criteria_match_level: $ref: '#/components/schemas/CriteriaMatchLevel' description: Label associated with the match score. required: - value UrlInfo: type: object description: >- URL link object with title, source information, and risk classification. Used for documents, news articles, and other web references. properties: url: type: string format: uri description: The URL of the document or article. example: https://www.bbc.com/news/article-123 title: type: string description: The title of the document or article. example: 'Breaking News: Major Development' source_name: type: string description: The name of the source that published the content. example: BBC News snippet: type: string description: >- Small snippet of text from the article, up to 2000 characters. Provides context without requiring full article access. example: The individual was mentioned in connection with... language: type: string description: ISO2 code of the language of the text, or blank if unknown. example: en flags: type: object description: >- Risk and sentiment classification flags from deep learning inference on the article text. properties: sentiment: type: array description: >- Sentiment classification with confidence level. Values include "Positive", "Neutral", or "Negative" followed by confidence (Low/Medium/High). items: type: string example: - Negative (High) risk: type: array description: >- One or more of 28 different types of financial crimes risk, with confidence level. Examples: "Money Laundering (High)", "Fraud/Bribery/Corruption (Medium)", "Other (Non-Financial) (Low)". items: type: string example: - Money Laundering (High) - Fraud/Bribery/Corruption (Medium) http_status_code: type: integer description: >- The HTTP status received by the test probe to determine content availability. example: 200 date_time_published: type: string description: Datetime string of when the article was published. Empty if unknown. example: '2024-01-15T10:30:00Z' required: - url - title ProfileChecklist: type: object description: >- Watchlist and risk screening states and sources. Contains the hit status for various risk feeds and detailed breakdown of each hit. properties: screen: $ref: '#/components/schemas/FeedScreen' description: Hit status for each feed (true for hit, false for clear). hits: $ref: '#/components/schemas/FeedHits' description: Lists of sources that Minerva found as hits for each feed. hits_info: type: array description: >- Detailed breakdown of hits with original source values and match scores for each attribute. items: $ref: '#/components/schemas/ScreeningHitInfo' required: - screen - hits - hits_info ClientRiskRating: type: object description: >- Customer Risk Rating (CRR) assessment on the profile based on discovered data. Provides overall risk score and breakdown of contributing factors. properties: score: type: number minimum: 0 maximum: 1 description: >- The customer risk rating score, normalized from 0.0-1.0. Higher values indicate higher risk. example: 0.75 label: type: string enum: - High - Medium - Low - None description: The risk rating label associated with the score. example: High factors: type: array description: >- List of criteria factors with their weights and values that comprise the total CRR analysis. items: $ref: '#/components/schemas/ClientRiskRatingFactor' required: - score - label - factors SourceDetailElement: type: object description: Metadata about a source providing additional information. properties: name: type: string description: The name of the source. example: OFAC SDN List source_feed: type: string description: The screening feed the source is associated with. example: Sanctions flagged_feeds: type: array description: The screening feeds that the source flagged. items: type: string example: - Sanctions - PEP urls: type: array description: URLs associated with the source. items: $ref: '#/components/schemas/UrlInfo' description: type: string description: Description of the source or explanation of why it has no URLs. example: Official US Treasury sanctions database inferences: type: array description: Inferences made from the source. items: $ref: '#/components/schemas/SourceDetailInference' required: - name - source_feed - flagged_feeds - urls - description - inferences MatchScoreInfo: type: object description: >- Detailed breakdown of the Criteria Match Score for each field provided in the search parameters. additionalProperties: $ref: '#/components/schemas/MatchScoreInfoField' example: name: score: 0.98 criteria_match_level: exact verified: true country: score: 0.85 criteria_match_level: close verified: true SourcedStringSource: type: object description: >- Single unit of data lineage for a sourced string value. Each source contributes to the value consensus. allOf: - $ref: '#/components/schemas/SourceFields' - type: object properties: value: type: string description: The value reported by this source. example: John Smith required: - value CriteriaMatchLevel: type: string enum: - exact - close - loose - none description: >- Label associated with a match score indicating the closeness of the match. Thresholds: exact (>= 0.98), close (>= 0.85), loose (>= 0.75), none (< 0.75). example: close DateObject: type: object description: A date object containing year, month, and day components. properties: year: type: integer description: >- The year component of the date. This will always be present if the date is known. It will be a 4 digit integer corresponding to a calendar year. example: 1984 month: type: integer minimum: 1 maximum: 12 description: >- The integer corresponding to the calendar month (1-12). May not be present if the month is not known. example: 6 day: type: integer minimum: 1 maximum: 31 description: >- The integer corresponding to the calendar day. May not be present if the day is not known. example: 15 required: - year SourcedDateSource: type: object description: Single unit of data lineage for a sourced date value. allOf: - $ref: '#/components/schemas/SourceFields' - type: object properties: value: $ref: '#/components/schemas/DateObject' description: The date value reported by this source. required: - value ProfileSocialUsername: type: object description: >- Social media username associated with the profile, discovered through deep learning investigation. properties: value: type: string description: The social media username. example: john_smith_official tag: type: string description: The name of the social media platform. example: Twitter sources: type: array description: Sources that contributed to the consensus value. items: $ref: '#/components/schemas/SourcedString' required: - value FeedScreen: type: object description: >- Hit status for each feed that was screened. True indicates a hit/finding, false indicates clear/no hits. properties: Sanctions: type: boolean description: >- True if profile is listed on an international sanctions list (OFAC SDN, HMT, OSFI Consolidated, etc.). PEP: type: boolean description: >- True if profile is a domestic PEP, foreign PEP, RCA of a PEP, head of a state-owned corporation, or HIO. Criminal: type: boolean description: >- True if profile is determined to be a criminal actor based on watchlists (e.g., FBI Terrorism List) or inference. Legal: type: boolean description: True if profile has high risk legal cases involving it. News: type: boolean description: >- True if profile has high risk adverse media articles (negative sentiment + adverse media risk categories). Open Source: type: boolean description: True if open source investigation found relevant hits. Social Media: type: boolean description: True if social media investigation found relevant hits. Registries: type: boolean description: True if corporate registry searches found relevant hits. Ownership: type: boolean description: True if ownership/beneficial ownership searches found relevant hits. Offshore: type: boolean description: True if offshore entity databases found relevant hits. FeedHits: type: object description: >- Lists of source names that were hit for each feed. Only present for feeds where screen value is true. properties: Sanctions: type: array items: type: string example: - OFAC SDN List - EU Consolidated List PEP: type: array items: type: string example: - World Leaders Database Criminal: type: array items: type: string example: - FBI Most Wanted Legal: type: array items: type: string example: - PACER News: type: array items: type: string example: - Reuters - BBC News Open Source: type: array items: type: string Social Media: type: array items: type: string Registries: type: array items: type: string Ownership: type: array items: type: string Offshore: type: array items: type: string ScreeningHitInfo: type: object description: >- Detailed breakdown of a screening hit with original source values and match scores for each attribute. Helps discern potential match identifiers from various risk sources. properties: source: type: string description: The name of the source that this hit was triggered from. example: OFAC SDN List feed: type: string description: The Minerva data feed that the source belongs to. enum: - Sanctions - PEP - News - Legal - Criminal example: Sanctions name: $ref: '#/components/schemas/ScreeningHitInfoField' description: Match attributes of the name that was hit upon from this source. occupation: $ref: '#/components/schemas/ScreeningHitInfoField' description: >- The job title reported by the hit source. Present for individual profiles only. Match score is 0.0 if not provided in search parameters. organization: $ref: '#/components/schemas/ScreeningHitInfoField' description: >- The organization reported by the hit source. Present for individual profiles only. Match score is 0.0 if not provided in search parameters. nationality: $ref: '#/components/schemas/ScreeningHitInfoField' description: >- The nationality reported by the hit source. Match score is 0.0 if country not provided in search parameters. date: $ref: '#/components/schemas/ScreeningHitInfoField' description: >- The date reported by the hit source (format: YYYY-MM-DD, YYYY, or YYYY-MM). Match score is 0.0 if date not provided in search parameters. locations: type: array description: >- Locations reported by the hit source. May contain address, city, state, and/or country. Match score is 0.0 if no location provided in search parameters. items: $ref: '#/components/schemas/ScreeningHitInfoField' required: - source - feed - name ClientRiskRatingFactor: type: object description: >- A single factor that contributed to an overall client risk rating (CRR) score. properties: weight: type: number minimum: 0 maximum: 1 description: >- The weight applied to the value when creating the consolidated weighted score. example: 0.15 value: type: number minimum: 0 maximum: 1 description: The value of the factor calculated, before weighting was applied. example: 0.8 code: type: integer description: >- Primary key mapping of the factor to the total list of possible criteria. Guaranteed to remain the same over time. example: 1 label: type: string description: >- Human-readable context about what this factor represents in the weighting scheme. example: Sanctions List annotation: type: string description: >- Additional notes providing further description about the factor value. example: Listed on OFAC SDN required: - weight - value - code - label SourceDetailInference: type: object description: >- Details regarding an inference made from a source, such as PEP or Criminal inference. properties: feed: type: string description: The screening feed that the inference flagged for. example: PEP reason: type: string description: The reason the inference was made. example: Matched regex pattern for political position url: type: string description: URL linking to the source of the inference data. example: https://example.com/article field: type: string description: The field the inference was made on. example: Notes context: type: string description: Snippet of text providing context for the inference. example: The individual served as Minister of... required: - feed - reason - url - field - context MatchScoreInfoField: type: object description: Match score information for a single search parameter field. properties: score: type: number minimum: 0 maximum: 1 description: >- Match score from 0.0-1.0 where 1.0 represents a perfect match and 0.0 represents no match. example: 0.95 criteria_match_level: $ref: '#/components/schemas/CriteriaMatchLevel' description: >- String label corresponding to the score: "exact" (>= 0.98), "close" (>= 0.85), "loose" (>= 0.75), "none" (< 0.75). verified: type: boolean description: >- True if the match meets verification requirements: source reputation_score >= 7 (trusted) AND criteria_match_level is at least "close". example: true required: - score - criteria_match_level - verified SourceFields: type: object description: Fields that are shared by all source lineage records. properties: source: type: string description: The human readable name of the source. example: OFAC SDN List feed: type: string description: >- The Minerva data feed that this source belongs to. Will be one of the 10 supported Minerva data feeds. enum: - Sanctions - PEP - Criminal - Legal - Offshore - Ownership - Registries - Social Media - News - Open Source example: Sanctions timestamp: $ref: '#/components/schemas/DateObject' description: >- The timestamp associated with when the data was collected or reported. inferred: type: boolean description: >- Indicates whether the value was inferred algorithmically (true) or reported directly from the source. Inferred values are down-weighted in the consensus algorithm. example: false reputation_score: type: integer minimum: 0 maximum: 10 description: >- Score from 0-10 indicating the reputation of the source. A value of 7 or above indicates "trusted" status where the source is highly accredited. example: 8 trusted: type: boolean description: >- Reports whether the reputation score is at or above the threshold (7) for the source to be considered trusted. example: true match_score: type: number minimum: 0 maximum: 1 description: >- Score from 0.0-1.0 indicating the closeness of the match between the search criteria and this source value. example: 0.92 criteria_match_level: $ref: '#/components/schemas/CriteriaMatchLevel' description: Label associated with the match score. ScreeningHitInfoField: type: object description: >- Information about the match for a single field from a potential screening hit. properties: value: type: string description: The value of the field that was matched. example: John Smith match_score: type: number minimum: 0 maximum: 1 description: >- The computed match score between the query parameter and the original source value. example: 0.95 criteria_match_level: $ref: '#/components/schemas/CriteriaMatchLevel' description: The label associated with the match score. required: - value - match_score - criteria_match_level securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- The Minerva API key used for this integration. Manage API keys in the Minerva dashboard under Administration > Developers. ````