openapi: 3.0.3 info: title: Evan - Adverse Media Monitoring description: Rest Api for Evan Adverse Media Monitoring contact: name: WorkFusion Inc - Adverse Media Monitoring url: >- https://www.workfusion.com/digital-workers/evan-ai-agent-for-adverse-media-monitoring/ version: 4.6.0 servers: - url: https://example-workfusion.workfusion.io description: Production server variables: {} security: - oauth: [] paths: /input-connector-rest/start-record-raw/{single-investigation-signal-id}: post: tags: - Evan - Adverse Media Monitoring Trigger Search summary: Start an adverse media monitoring search description: Start an adverse media monitoring search operationId: startBusinessProcessRaw parameters: - name: single-investigation-signal-id in: path description: >- This parameter identifies the signal ID for the BP where the record is to be sent. Defaults to null. The parameter type is string. It can be found in the data tab of the business process in Control Tower required: true schema: type: string example: cbdbe2a8-2f4b-4240-b3ad-2273ba34902b requestBody: content: application/json: schema: $ref: '#/components/schemas/AmmRequest' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ProcessStartResponse' '404': description: BusinessProcess not found /input-connector-rest/start-record-raw/{batch-investigation-signal-id}: post: tags: - Evan - Adverse Media Monitoring Batch summary: Start an adverse media monitoring search in batch mode description: Start an adverse media monitoring search operationId: startBusinessProcessRaw parameters: - name: batch-investigation-signal-id in: path description: >- This parameter identifies the signal ID for the Batch BP where the record is to be sent. Defaults to null. The parameter type is string. It can be found in the data tab of the business process in Control Tower required: true schema: type: string example: cbdbe2a8-2f4b-4240-b3ad-2273ba34902b requestBody: content: application/json: schema: $ref: '#/components/schemas/AmmBatchRequest' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ProcessStartResponse' '404': description: BusinessProcess not found /input-connector-rest/check-record-status/{request-id}: get: tags: - Evan - Adverse Media Monitoring - Check Results summary: Check status of running business process description: Check the status of an adverse media search that has been started operationId: check-record-status parameters: - name: request-id in: path description: >- This parameter identifies the request ID for the record. It is returned by the start record operation. required: true schema: type: string example: asd1234 responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/ProcessStartResponse' /input-connector-rest/get-record-result/{request-id}: get: tags: - Evan - Adverse Media Monitoring - Check Results summary: Get output of business process description: >- Returns a completed adverse media search. This should only be run after check-record-status is is complete operationId: get-record-result parameters: - name: request-id in: path description: >- This parameter identifies the request ID for the record. It is returned by the start record operation. required: true schema: type: string example: asd1234 responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/AmmResponse' /input-connector-rest/get-record-result/{batch-request-id}: get: tags: - Evan - Adverse Media Monitoring Batch summary: Get output of batch business process description: >- Returns a completed batch investigation. This should only be run after check-record-status is is complete operationId: get-record-result parameters: - name: batch-request-id in: path description: >- This parameter identifies the request ID for the record. It is returned by the start record operation. required: true schema: type: string example: asd1234 responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/BatchAmmResponse' /dummy/path/to/manual-review/webhook: post: tags: - Evan - Adverse Media Monitoring Webhook Triggers summary: Send manual review to webhook description: >- Will send the alert details sent to manual review to the webhook url configured in Evan's settings requestBody: content: application/json: schema: $ref: '#/components/schemas/ManualReviewAlert' required: true responses: '200': description: successful operation /dummy/path/to/final-results/webhook: post: tags: - Evan - Adverse Media Monitoring Webhook Triggers summary: Send final results to webhook description: >- Will send the the final results to the webhook url configured in Evan's settings requestBody: content: application/json: schema: $ref: '#/components/schemas/AmmResponse' required: true responses: '200': description: successful operation /dummy/path/to/error/webhook: post: tags: - Evan - Adverse Media Monitoring Webhook Triggers summary: Send error details to webhook description: >- Will send the error details to the webhook url configured in Evan's settings requestBody: content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDto' required: true responses: '200': description: successful operation components: schemas: ProcessStartResponse: type: object properties: requestId: type: string description: Request Id to use to interrogate the system later example: 6be8fc11-1701 status: type: string example: IN_PROGRESS enum: - IN_PROGRESS - READY_FOR_REVIEW - RETRYING - FAILED - COMPLETED - STOPPED statusDetails: type: string example: In progress AmmResponse: type: object properties: transactionUUID: type: string description: Unique identifier assigned to the request example: f5eff4b5-06bc-4016-8f7d-740ef1023629 runUUID: type: string description: Identifier of the run example: f5eff4b5-06bc-4016-8f7d-740ef1023629 variationUUID: type: integer description: Unique identifier of the variation that was used by investigation example: 7 batchId: type: string description: >- Batch identifier for grouping multiple investigations (comes from the request data) example: f5e0ef10236FdpgQf1f29Mp entityId: type: string description: >- Unique identifier of the screened entity (comes from the request data) example: f5e0ef10236FdpgQf1f29Mp externalId: type: string description: External identifier (comes from the request data) example: f5e0ef10236FdpgQf1f29Mp startTime: type: string format: date-time description: Execution start time reviewStartTime: type: string format: date-time description: Manual task first creation time reviewEndTime: type: string format: date-time description: Manual task submission time endTime: type: string format: date-time description: Execution end time timestamp: type: string format: date-time description: Total execution time investigationDate: type: string format: date-time description: Investigation's creation date and time searchRequest: type: string description: Entity name to be screened example: James Bond investigationStatus: type: string description: Status of the investigation example: FALSE_POSITIVE enum: - FALSE_POSITIVE - TRUE_POSITIVE - NEEDS_INVESTIGATION - NO_RESULTS_FOUND - EXPIRED - FAILED mlInvestigationStatus: type: string description: Investigation status calculated by the ML model example: NEEDS_INVESTIGATION enum: - FALSE_POSITIVE - TRUE_POSITIVE - NEEDS_INVESTIGATION - NO_RESULTS_FOUND - EXPIRED - FAILED manualReviewInvestigationStatus: type: string description: >- Investigation status set on the Manual task on the investigation level example: FALSE_POSITIVE enum: - FALSE_POSITIVE - TRUE_POSITIVE - NEEDS_INVESTIGATION - NO_RESULTS_FOUND - EXPIRED - FAILED mlModelId: type: string description: Identifier of the ML model version example: amm-classification-v1 newsProviders: type: array items: type: string enum: - GOOGLE - BRAVE - FACTIVA_HEADLINES - LEXIS_NEXIS_LP_MEDIA - WORLD_CHECK_ONE - EXTERNAL_SOURCE description: Providers used to get the news example: '["GOOGLE"]' manualTaskExecuted: type: boolean description: Flag to indicate if the manual task was executed reviewerUUID: type: string description: Unique identifier assigned to the user who reviewed the article example: 3b6875ef-78b0-4e9f-a45f-826a78fcf15 reviewerName: type: string description: Name of User who reviewed the article. example: John Smith reviewerEmail: type: string description: Email of User who reviewed the investigation. example: jsmith@example.com reviewComment: type: string description: Comments made by the reviewer about the article example: Not relevant reportLink: type: string description: Link to the human readable report generate by the business process example: >- https://demo.workfusion.io/doc-upload/adverse-media-monitoring/3.2.0-EXPERT-9503/3294af8d-2c98-48d0-a15d-df17057b58b4/084975ba-6950-4bce-ad33-e1d90d2cafd0/report/html/2023-01-10-James-Bond-needs-investigation-084975ba-6950-4bce-ad33-e1d90d2cafd0.html additionalInformation: type: string description: >- Additional information that should be visible (comes from the request data) example: The subject has a drug addiction status: type: string description: Status of the investigation example: COMPLETED articles: type: array xml: wrapped: true items: $ref: '#/components/schemas/ArticleResponseDto' shorthandDecision: type: array items: type: string description: >- Pre-defined reason chosen in the Manual Task (values come from Evan settings "Shorthand list of predefined reasons") example: '["Approved"]' mlInvestigationSummary: type: string description: >- Descriptive summary of articles, generated either by the LLM (when LLM-generated summary is enabled) or from ML decisions + decision reapplication (when disabled). Only one engine produces it per investigation. manualReviewInvestigationSummary: type: string description: >- Descriptive summary of articles built from manual review dispositions after the MT was submitted and LLM-generated summary is disabled ArticleResponseDto: type: object properties: articleUUID: type: string description: Unique identifier assigned to the article example: 642dab31-c4c5-44ea-b94c-bf2ce827664d duplicateArticleUUID: type: string description: Unique identifier of duplicate article example: c81ed794-eb78-4a17-840f-d813f6695093 historyId: type: string description: Unique hash of article history identifier example: eca71631ae86e7a6828ac39e6290cac83b9e117db62ced09b773597a13cf1f44 title: type: string example: >- Remarks by Prime Minster on a Successful Investigation concluded that summary: type: string example: >- Remarks by Prime Minster on a Successful Investigation concluded that.. investigationStatus: type: string enum: - FALSE_POSITIVE - TRUE_POSITIVE - NEEDS_INVESTIGATION - NO_RESULTS_FOUND - EXPIRED - FAILED mlInvestigationStatus: type: string description: Investigation status calculated by ML model on the article level example: NEEDS_INVESTIGATION enum: - FALSE_POSITIVE - TRUE_POSITIVE - NEEDS_INVESTIGATION - NO_RESULTS_FOUND - EXPIRED - FAILED mtInvestigationStatus: type: string description: >- Investigation status that was shown to user on the Manual task on the article level example: FALSE_POSITIVE enum: - FALSE_POSITIVE - TRUE_POSITIVE - NEEDS_INVESTIGATION - NO_RESULTS_FOUND - EXPIRED - FAILED manualReviewInvestigationStatus: type: string description: Investigation status set on the Manual task on the article level example: TRUE_POSITIVE enum: - FALSE_POSITIVE - TRUE_POSITIVE - NEEDS_INVESTIGATION - NO_RESULTS_FOUND - EXPIRED - FAILED adjudicationReason: type: string example: NON_ADVERSE enum: - NON_ADVERSE - NON_FOCAL - YOB_WAS_NOT_PROVIDED - YOB_OR_AGE_WAS_NOT_FOUND - YOB_MISMATCH - YOB_MATCH - NEEDS_INVESTIGATION - ENTITY_WAS_NOT_FOUND - TYPES_ARE_DIFFERENT - PUBLICATION_YEAR_WAS_NOT_RECOGNIZED - ENTITY_IN_ARTICLE_IS_OLDER_THAN_SCREENED_ENTITY - SCREENED_ENTITY_IS_YOUNGER_THAN_THE_ARTICLE - TRUE_POSITIVE - DUPLICATE - ARTICLE_PARSING - UNSUPPORTED_LANGUAGE - UNSUPPORTED_FORMAT - BEHIND_PAYWALL - HUGE_ARTICLE - POOR_ARTICLE - EMPTY_ARTICLE - DOWNLOAD_ARTICLE_EXCEPTION - WEBSITE_IGNORE - ARTICLE_ON_SANCTIONS_SITE - LLM_RESPONSE_FALSE_POSITIVE - LLM_RESPONSE_NEEDS_INVESTIGATION - LLM_RESPONSE_TRUE_POSITIVE - JS_REQUIRED - EXTERNAL_SOURCE_DECISION publishingDate: type: string format: date author: type: string example: April O'Neil languages: type: array items: type: string enum: - EN - ES - ANY - EN_ES - UNKNOWN description: Detected languages for article content example: '["EN", "ES"]' originalLanguages: type: array items: type: string description: Original languages of article content example: '["en", "fr"]' wordCount: type: integer example: 1414 source: type: string description: Website the article came from example: skynews.com articleLink: type: string description: Link to a copy of the article downloaded to our server example: >- https://demo.workfusion.io/doc-upload/adverse-media-monitoring/3.2.0-EXPERT-9503/800859bd-6e06-4e60-9fec-4c70fedef2e5/79146ac2-b9f3-4174-93d9-d7744acd1233/article-content/32fe0266-dbaf-4ff3-a636-691f3ad6b657.html originalArticleLink: type: string description: Link to the article at its original location example: https://www.nbcnews.com/politics/national-security/article archiveLink: type: string description: Link to the archived version of the article example: https://web.archive.org/web/20230210134410 score: type: number description: Machine learning score example: 0.5781505340844829 focalityScore: type: number description: Machine learning focality score example: 0.5781505340844829 matchedEntities: type: array description: Machine learning extracted entities example: >- [{"name":"John Doe","score":"1.0"}, {"name":"John", "score":"0.87"}, {"name":"Doe","score":"0.87"}] isReviewed: type: boolean reviewerUUID: type: string description: Unique identifier assigned to the user who reviewed the article example: 3b6875ef-78b0-4e9f-a45f-826a78fcf15 reviewerName: type: string description: Name of User who reviewed the article example: John Smith reviewerEmail: type: string description: Email of User who reviewed the article example: jsmith@example.com mlComment: type: string description: Comment generated by the ML model for the article example: ML generated analysis reviewComment: type: string description: Comments made by the reviewer about the article example: Not relevant comment: type: string description: Final article comment example: Final comment reviewDate: type: string format: date-time description: >- Date and time when comments was made by the reviewer about the article example: '2025-07-18T15:15:05Z' errorCode: type: string description: Error code for not processing article enum: - ARTICLE_CONTENT_EMPTY - ARTICLE_CONTENT_HUGE - ARTICLE_DOWNLOAD - ARTICLE_DOWNLOAD_INTERRUPTED - ARTICLE_DOWNLOAD_TIMEOUT - ARTICLE_HUGE - ARTICLE_NOT_FOUND - ARTICLE_PARSING - ARTICLE_POOR - CONTENT_LENGTH_TOO_BIG - EXCLUDED_FORMAT - FACTIVA_HEADLINES_ERROR - ML_PROCESSING - PARSED_ARTICLE_EMPTY - POOL_TIMEOUT_EXCEEDED - REDIRECT_LINK - TOO_MANY_TAGS - UNSUPPORTED_FORMAT - UNSUPPORTED_LANGUAGE - WEBSITE_BEHIND_PAYWALL - WEBSITE_FORBIDDEN_DOWNLOAD - JS_REQUIRED provider: type: string description: Provider from which article has been retrieved example: GOOGLE shorthandDecision: type: array items: type: string description: >- Pre-defined reason chosen in the Manual Task (values come from Evan settings "Shorthand list of predefined reasons") example: '["Approved"]' AmmRequest: type: object required: - search_request properties: search_request: type: string description: Entity to search. Mandatory example: James Bond gender: type: string description: Entity's gender example: MALE enum: - MALE - FEMALE entity_type: type: string example: INDIVIDUAL enum: - COMPANY - INDIVIDUAL residence_operating_country: type: string description: 2 letter ISO Country code where the entity resides example: US citizenship_incorporation_country: type: string description: >- 2 letter ISO Country code where the entity has registered their nationality example: US subdivision: type: string description: >- iso_3166_alpha_2_code of the subdivision (State / County / Province etc.) example: US-MO city: type: string description: >- City name. Residence country is required to use City in the search request example: Jefferson City year_of_birth_incorporation: type: integer description: This is used only if date_of_birth_incorporation is not set example: 1960 date_of_birth_incorporation: type: string description: This value will override year_of_birth_incorporation format: >- Will use the preferred date format set in the Digital Worker settings example: '2011-07-18T00:00:00Z' search_period: type: integer description: value is in days example: 90 batch_id: type: string description: Batch identifier for grouping multiple investigations example: f5e0ef10236FdpgQf1f29Mp batch_size: type: integer description: >- The number of requests in batch. The combined and batch report will not be generated if this field is null example: 20 entity_id: type: string description: External ID of the entity example: f5e0ef10236FdpgQf1f29Mp external_id: type: string description: External ID of the request example: f5e0ef10236FdpgQf1f29Mp additional_information: type: string description: Entity Additional Information example: This individual has additional information add_to_ongoing_monitor: type: boolean description: Add the entity to ongoing monitor example: true ongoing_monitoring: type: boolean description: >- Indicates whether the incoming request originates from an ongoing monitoring connector example: true cost_center_code: type: string description: Cost center team code example: cost_center_code cost_center_name: type: string description: Cost center team name example: cost_center_name sla_date: type: string description: Service Level Agreement (SLA) date for filtering in the manual tasks format: >- Will use the preferred date format set in the Digital Worker settings example: '2011-07-18T00:00:00Z' article_data: type: array xml: wrapped: true items: $ref: '#/components/schemas/ArticleInputData' business_line: type: string description: Business line example: News screening_service: type: string description: Screening service example: AdvNews investigation_date: type: string description: >- The date when investigation was started. Will be set to current time if empty. format: ISO 8601 datetime format example: '2025-07-18T12:33:10Z' initiator: type: string description: Request initiator's name example: John Doe sla_duration: type: string description: SLA duration in a text format example: 5 hours related_entity_id: type: string description: Related entity ID example: REI123 _sys_mt_hit_assignee: type: string _sys_mt_hit_assigned_user_groups: type: string _sys_mt_hit_priority: type: integer review_availability_date: type: string description: >- The review availability date. Investigations with a date earlier than the current date are filtered out and not displayed in the Workspace. format: ISO 8601 datetime format example: '2025-06-17T12:15:22Z' AmmBatchRequest: type: object properties: batch_id: type: string description: >- Batch identifier for grouping multiple investigations. A random UUID will be used in case it is not present. example: f5e0ef10236FdpgQf1f29Mp notification_emails: type: array description: >- List of emails to send notifications about the batch processing and BP's results example: - email1@email.com - email2@email.com items: type: string description: >- List of emails to send notifications about the batch processing and BP's results example: '["email1@email.com","email2@email.com"]' input_data: type: array items: $ref: '#/components/schemas/AmmRequest' ArticleInputData: type: object properties: link: type: string description: >- Link to the article. At least one of the link, content or content_link fields must be present. example: https://www.bbc.com/news/articles/ckgxk40ndk1o additional_information: type: string description: Article Additional Information example: This article was downloaded from the trusted source external_provider_name: type: string description: Name of the provider that returned the article example: Google title: type: string description: Title of the article example: >- Who will be the next pope? Key candidates in an unpredictable contest summary: type: string description: Summary of the article example: >- Several names are in the fray as cardinals prepare to gather in the Vatican to elect Pope Francis' successor. content: type: string description: >- The article content. At least one of the link, content or content_link fields must be present. If both link and content are provided, the content will be overwritten with the content from link if it is successfully downloaded. example: >- The big text that represents article content in HTML or \n plain text format. content_link: type: string description: >- Link to the place, where article content is stored. At least one of the link, content or content_link fields must be present. If both link and content_link are provided, the content from the content_link will be overwritten with the content from link if it is successfully downloaded. If both content and content_link are provided, the content will be ignored. example: https://s3.web-server.com/bucket/path/article-content.txt external_provider_search_url: type: string description: Link to the external provider search result example: https://www.google.com/search?q=article-title publication_date: type: string format: date description: Article publication date example: '2023-09-20' relevance_score: type: number description: Article relevance value example: 0.85 ManualReviewAlert: type: object properties: transactionUUID: type: string description: Unique identifier assigned to the request example: f5eff4b5-06bc-4016-8f7d-740ef1023629 runUUID: type: string description: Identifier of the run example: f5eff4b5-06bc-4016-8f7d-740ef1023629 batchId: type: string description: >- Batch identifier for grouping multiple investigations (comes from the request data) example: f5e0ef10236FdpgQf1f29Mp variationUUID: type: integer description: Unique identifier of the variation that was used by investigation example: 7 entityId: type: string description: >- Unique identifier of the screened entity (comes from the request data) example: f5e0ef10236FdpgQf1f29Mp externalId: type: string description: External identifier (comes from the request data) example: f5e0ef10236FdpgQf1f29Mp timestamp: type: string format: date-time description: Response time startTime: type: string format: date-time description: Execution start time searchRequest: type: string description: Entity name to be screened example: James Bond investigationStatus: type: string description: Status of the investigation enum: - FALSE_POSITIVE - TRUE_POSITIVE - NEEDS_INVESTIGATION - NO_RESULTS_FOUND - EXPIRED - FAILED additionalInformation: type: string description: >- Additional information that should be visible (comes from the request data) example: The subject has a drug addiction manualTaskUrl: type: string description: Link to the workspace's assignement example: >- https://demo.workfusion.io/workspace/assignments/ce177257-7ca0-4d6b-8f9e-892967356860 status: type: string description: Status of the investigation example: READY_FOR_REVIEW articles: type: array xml: wrapped: true items: $ref: '#/components/schemas/ManualReviewAlertArticleInfo' ManualReviewAlertArticleInfo: type: object properties: articleUUID: type: string description: Unique identifier assigned to the article example: 642dab31-c4c5-44ea-b94c-bf2ce827664d duplicateArticleUUID: type: string description: Unique identifier of duplicate article example: c81ed794-eb78-4a17-840f-d813f6695093 title: type: string example: >- Remarks by Prime Minster on a Successful Investigation concluded that investigationStatus: type: string enum: - FALSE_POSITIVE - TRUE_POSITIVE - NEEDS_INVESTIGATION - NO_RESULTS_FOUND - EXPIRED - FAILED adjudicationReason: type: string enum: - NON_ADVERSE - NON_FOCAL - YOB_WAS_NOT_PROVIDED - YOB_OR_AGE_WAS_NOT_FOUND - YOB_MISMATCH - YOB_MATCH - NEEDS_INVESTIGATION - ENTITY_WAS_NOT_FOUND - TYPES_ARE_DIFFERENT - PUBLICATION_YEAR_WAS_NOT_RECOGNIZED - ENTITY_IN_ARTICLE_IS_OLDER_THAN_SCREENED_ENTITY - SCREENED_ENTITY_IS_YOUNGER_THAN_THE_ARTICLE - TRUE_POSITIVE - DUPLICATE - ARTICLE_PARSING - UNSUPPORTED_LANGUAGE - UNSUPPORTED_FORMAT - BEHIND_PAYWALL - HUGE_ARTICLE - POOR_ARTICLE - EMPTY_ARTICLE - DOWNLOAD_ARTICLE_EXCEPTION - WEBSITE_IGNORE - ARTICLE_ON_SANCTIONS_SITE - LLM_RESPONSE_FALSE_POSITIVE - LLM_RESPONSE_NEEDS_INVESTIGATION - LLM_RESPONSE_TRUE_POSITIVE - JS_REQUIRED - EXTERNAL_SOURCE_DECISION publishingDate: type: string format: date author: type: string example: April O'Neil languages: type: array items: type: string enum: - EN - ES - ANY - EN_ES - UNKNOWN description: Detected languages for article content example: '["EN", "ES"]' originalLanguages: type: array items: type: string description: Original languages of article content example: '["de", "fr"]' wordCount: type: integer example: 1414 source: type: string description: Website the article came from example: skynews.com articleLink: type: string description: Link to a copy of the article downloaded to our server example: >- https://demo.workfusion.io/doc-upload/adverse-media-monitoring/3.2.0-EXPERT-9503/800859bd-6e06-4e60-9fec-4c70fedef2e5/79146ac2-b9f3-4174-93d9-d7744acd1233/article-content/32fe0266-dbaf-4ff3-a636-691f3ad6b657.html originalArticleLink: type: string description: Link to the article at its original location example: https://www.nbcnews.com/politics/national-security/article score: type: number description: Machine learning score example: 0.5781505340844829 errorCode: type: string description: Error code for not processing article enum: - ARTICLE_CONTENT_EMPTY - ARTICLE_CONTENT_HUGE - ARTICLE_DOWNLOAD - ARTICLE_DOWNLOAD_INTERRUPTED - ARTICLE_DOWNLOAD_TIMEOUT - ARTICLE_HUGE - ARTICLE_NOT_FOUND - ARTICLE_PARSING - ARTICLE_POOR - CONTENT_LENGTH_TOO_BIG - EXCLUDED_FORMAT - FACTIVA_HEADLINES_ERROR - ML_PROCESSING - PARSED_ARTICLE_EMPTY - POOL_TIMEOUT_EXCEEDED - REDIRECT_LINK - TOO_MANY_TAGS - UNSUPPORTED_FORMAT - UNSUPPORTED_LANGUAGE - WEBSITE_BEHIND_PAYWALL - WEBSITE_FORBIDDEN_DOWNLOAD - JS_REQUIRED ErrorResponseDto: type: object properties: transactionUUID: type: string description: Unique identifier assigned to the request example: f5eff4b5-06bc-4016-8f7d-740ef1023629 runUUID: type: string description: Identifier of the run example: f5eff4b5-06bc-4016-8f7d-740ef1023629 variationUUID: type: integer description: Unique identifier of the variation that was used by investigation example: 7 batchId: type: string description: >- Batch identifier for grouping multiple investigations (comes from the request data) example: f5e0ef10236FdpgQf1f29Mp batchSize: type: integer description: >- The number of requests in batch. The combined and batch report will not be generated if this field is null example: 20 entityType: type: string description: Type of the screened entity example: COMPANY enum: - COMPANY - INDIVIDUAL entityId: type: string description: >- Unique identifier of the screened entity (comes from the request data) example: f5e0ef10236FdpgQf1f29Mp externalId: type: string description: External identifier (comes from the request data) example: f5e0ef10236FdpgQf1f29Mp startTime: type: string format: date-time description: Execution start time originalSearchRequest: type: string description: Original search request example: James Bond timestamp: type: string format: date-time description: Response time status: type: string description: Status of the investigation. Always "FAILED" for error response example: FAILED errorMessage: type: string description: Human-readable error message describing the failure example: Provider rate limit exceeded AmmQCRequest: type: object required: - investigation_uuid properties: investigation_uuid: description: UUID of the investigation that should be re-run. Mandatory type: string example: 5da98f7a-f365-4de9-9b42-23fced6dd43c BatchAmmResponse: type: object properties: batchId: type: string description: The ID of the batch. example: e4eaaaf0-2b67-4314-9a2b-93960634be72 runUUID: type: string description: The UUID of the run. format: uuid example: a1b2c3d4-e5f6-7890-1234-567890abcdef batchSize: type: integer description: The size of the batch. format: int32 example: 20 combinedReportLink: type: string description: The link to the combined report. example: https://combined-report-link batchReportLink: type: string description: The link to the batch report. example: https://batch-report-link qcReportLink: type: string description: The link to the QC report. example: https://qc-report-link investigationResults: type: array description: The results of the investigations. items: $ref: '#/components/schemas/AmmResponse' failedInvestigations: type: array description: The investigations that failed. items: $ref: '#/components/schemas/ErrorResponseDto' description: Represents the response for a batch of investigations. securitySchemes: bearer: type: http description: >- Bearer API token to authorize requests. This scheme may be useful for testing, when bearer token has been already generated and available to use. scheme: bearer bearerFormat: JWT oauth: type: oauth2 description: >- This API uses OAuth 2 with password grant flow. This is default and recommended authentication mechanism. flows: password: tokenUrl: >- https://example-keycloak.workfusion.io/auth/realms/WorkfusionRealm/protocol/openid-connect/token scopes: openid: ''