{"components":{"schemas":{"AuthResponsesAccountStatus":{"properties":{"apiKey":{"example":"bea8252ff4e80f41719ea13cdf007273","type":"string"},"createdAt":{"format":"date-time","type":"string"},"expiresAt":{"format":"date-time","nullable":true,"type":"string"},"organizationName":{"example":"ACME Inc.","type":"string"},"remainingCalls":{"description":"Remaining lifetime API calls allowed (Test keys)","type":"integer"},"testKey":{"example":false,"type":"boolean"}},"type":"object"},"CommonEntitySource":{"properties":{"sourceID":{"description":"The ID of the process run that created the entity","type":"string"},"sourceType":{"description":"Which kind of process created or referenced the entity","type":"string"}},"type":"object"},"RequestAlertsListingRequestPubliclyDocumented":{"items":{"type":"string"},"nullable":true,"type":"array"},"RequestArchiveEntityRequestPublic":{"properties":{"customerKeys":{"description":"The entity customer keys to archive.","items":{"type":"string"},"nullable":true,"type":"array"},"entityURNs":{"description":"The entity URNs to archive.","items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"},"RequestCreateEntityGroupRequestPublic":{"properties":{"entityGroupName":{"type":"string"}},"type":"object"},"RequestDateRangeRequest":{"properties":{"since":{"description":"The start of the date range.","example":"2023-01-01T00:00:00Z","format":"date-time","nullable":true,"type":"string"},"until":{"description":"The end of the date range.","example":"2023-01-01T00:00:00Z","format":"date-time","nullable":true,"type":"string"}},"type":"object"},"RequestEntitiesFilterRequest":{"items":{"type":"string"},"nullable":true,"type":"array"},"RequestEntitiesHistoriesRequestPublic":{"properties":{"createdAt":{"$ref":"#/components/schemas/RequestDateRangeRequest"},"cursor":{},"groupIDs":{"description":"Optional. An array of group IDs to include entities from.","items":{"minimum":0,"type":"integer"},"nullable":true,"type":"array"},"historyTypes":{"description":"Optional. An array of history types to include. Empty means all.","enum":["lifecycle","review","alert","disposition","monitoring","configuration"],"items":{"type":"string"},"nullable":true,"type":"array"},"page":{"description":"Page number, 1-indexed. Default: 1","example":1,"type":"integer"},"pageSize":{"description":"Number of results per page. Maximum: 100, Default: 10","example":10,"type":"integer"},"total":{"description":"Total number of results. Ignored in requests, used in responses.","example":15000,"type":"integer"}},"type":"object"},"RequestEntitiesRequestPublic":{"properties":{"filters":{"$ref":"#/components/schemas/RequestEntitiesFilterRequest"},"page":{"description":"Page number, 1-indexed. Default: 1","example":1,"type":"integer"},"pageSize":{"description":"Number of results per page. Maximum: 100, Default: 10","example":10,"type":"integer"},"sortBy":{"description":"The field name that you want to sort by. Many fields in the response are sortable, but not all.","nullable":true,"type":"string"},"sortOrder":{"description":"ASC or DESC. Defaults: DESC","example":"asc","nullable":true,"type":"string"},"total":{"description":"Total number of results. Ignored in requests, used in responses.","example":15000,"type":"integer"}},"type":"object"},"RequestEntitiesUploadRequestPublic":{"properties":{"entityGroupIDs":{"items":{"minimum":0,"type":"integer"},"nullable":true,"type":"array"},"filterSetID":{"minimum":0,"type":"integer"},"searches":{"items":{"$ref":"#/components/schemas/SigmaidBasicSearchParams"},"nullable":true,"type":"array"}},"required":["filterSetID","entityGroupIDs"],"type":"object"},"RequestEntityHistoryRequestPublic":{"properties":{"page":{"description":"Page number, 1-indexed. Default: 1","example":1,"type":"integer"},"pageSize":{"description":"Number of results per page. Maximum: 100, Default: 10","example":10,"type":"integer"},"total":{"description":"Total number of results. Ignored in requests, used in responses.","example":15000,"type":"integer"}},"type":"object"},"RequestEntityNewsFilters":{"properties":{"endTime":{"type":"string"},"eventEntityRisks":{"items":{"type":"string"},"nullable":true,"type":"array"},"eventType":{"type":"string"},"eventTypes":{"items":{"type":"string"},"nullable":true,"type":"array"},"isDecisionedAgainst":{"description":"Only return news that has been marked accepted or decisioned against.","type":"boolean"},"languages":{"items":{"type":"string"},"nullable":true,"type":"array"},"matchIDs":{"description":"An array of match IDs to include news from.","items":{"type":"string"},"nullable":true,"type":"array"},"matchNames":{"items":{"type":"string"},"nullable":true,"type":"array"},"minMaterialityScore":{"type":"number"},"onlyReviewRequiredNews":{"description":"Only return news that requires review. Causes isDecisionedAgainst to be ignored","type":"boolean"},"publisherCountries":{"items":{"type":"string"},"nullable":true,"type":"array"},"publisherRegions":{"items":{"type":"string"},"nullable":true,"type":"array"},"publisherSubRegions":{"items":{"type":"string"},"nullable":true,"type":"array"},"startTime":{"type":"string"},"territories":{"items":{"type":"string"},"nullable":true,"type":"array"},"yearsOfBirth":{"items":{"type":"integer"},"nullable":true,"type":"array"}},"type":"object"},"RequestEntityNewsRequestPublic":{"properties":{"filters":{"$ref":"#/components/schemas/RequestEntityNewsFilters"},"page":{"description":"Page number, 1-indexed. Default: 1","example":1,"type":"integer"},"pageSize":{"description":"Number of results per page. Maximum: 100, Default: 10","example":10,"type":"integer"},"sortBy":{"description":"The field name that you want to sort by. Many fields in the response are sortable, but not all.","nullable":true,"type":"string"},"sortOrder":{"description":"ASC or DESC. Defaults: DESC","example":"asc","nullable":true,"type":"string"},"total":{"description":"Total number of results. Ignored in requests, used in responses.","example":15000,"type":"integer"}},"type":"object"},"RequestFullSingleScreeningRequestPublic":{"properties":{"aliases":{"description":"Secondary names to perform a search on","items":{"example":"InGen, InGen Corp","type":"string"},"nullable":true,"type":"array"},"countries":{"description":"ISO 3166-1 alpha-2","items":{"example":"US","type":"string"},"nullable":true,"type":"array"},"createAlerts":{"default":false,"description":"Optional. If true, alerts will be generated for this query if the results contain risk. Alerts are available in the UI or through webhook notifications.","nullable":true,"type":"boolean"},"customFields":{"description":"Optional. A list of custom fields to be associated with the entity for cross-referencing or disambiguation in alerts and monitoring. Does not affecting risk or matching logic. Each field must have a unique key.","items":{"$ref":"#/components/schemas/SigmaidCustomEntityField"},"nullable":true,"type":"array"},"customerKey":{"description":"Optional. A user-provided identifier that will be returned in alerts and monitoring. Any format.","example":"ABC1234567890","type":"string"},"dob":{"description":"Birth or foundation date. YYYY, YYYY-MM, YYYY-MM-DD, YYYY/MM or YYYY/MM/DD format.","example":"1993-06-11","nullable":true,"type":"string"},"entityName":{"description":"The primary name of the search","example":"InGen Corporation","type":"string"},"entityType":{"enum":["person","company","aircraft","vessel"],"example":"company","nullable":true,"type":"string"},"filterSetID":{"description":"The Filter Set to use for this search. You may create and view your filtersets in the UI, under Settings \u003e Filter Sets..","minimum":0,"type":"integer"}},"required":["entityName","filterSetID"],"type":"object"},"RequestMatchesSummaryRequestPublic":{"properties":{"sigmaIDs":{"description":"Optional. Narrow the results to only include these Sigma IDs.","items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"},"RequestSingleEntityUploadRequestPublic":{"properties":{"entityGroupIDs":{"items":{"minimum":0,"type":"integer"},"nullable":true,"type":"array"},"filterSetID":{"minimum":0,"type":"integer"},"search":{"$ref":"#/components/schemas/SigmaidBasicSearchParams"}},"required":["filterSetID","entityGroupIDs"],"type":"object"},"ResponseAlertIndicatorSummary":{"properties":{"category":{"example":"Sanctions","type":"string"},"count":{"example":2,"type":"integer"},"isNetwork":{"description":"Indicates whether the indicator is describes this entity or one of its network connections","example":false,"type":"boolean"},"lastAddedAt":{"description":"The most recent time an indicator was added to the alert.","format":"date-time","type":"string"},"maxScore":{"example":100,"type":"integer"}},"type":"object"},"ResponseAlertSummary":{"properties":{"alertIndicatorSummary":{"description":"The indicators in this alert, which is different from the full list of indicators in the entity.","items":{"$ref":"#/components/schemas/ResponseAlertIndicatorSummary"},"nullable":true,"type":"array"},"closedAt":{"description":"When the alert was closed. Null if the alert is still open. Alerts cannot be reopened once closed.","format":"date-time","nullable":true,"type":"string"},"closedByUserName":{"description":"Name of the user who closed the alert.","nullable":true,"type":"string"},"closedByUserURN":{"description":"URN of the user who closed the alert.","nullable":true,"type":"string"},"createdAt":{"description":"When the alert was first created.","format":"date-time","type":"string"},"entityCreatedAt":{"format":"date-time","type":"string"},"entityCustomFields":{"items":{"$ref":"#/components/schemas/SigmaidCustomEntityField"},"nullable":true,"type":"array"},"entityCustomerKey":{"description":"The customer key of the entity associated with this alert.","type":"string"},"entityDispositionState":{"$ref":"#/components/schemas/ResponseEntityDispositionState"},"entityEscalated":{"description":"Whether the entity has been escalated for review.","type":"boolean"},"entityEscalatedByUserName":{"description":"If escalated, the name of the user who escalated the entity.","nullable":true,"type":"string"},"entityEscalatedByUserUrn":{"description":"If escalated, the URN of the user who escalated the entity.","nullable":true,"type":"string"},"entityEscalatedTime":{"description":"If escalated, the time when the entity was escalated.","format":"date-time","nullable":true,"type":"string"},"entityFilterSetID":{"minimum":0,"type":"integer"},"entityFilterSetName":{"type":"string"},"entityGroups":{"description":"The groups that this entity belongs to.","items":{"$ref":"#/components/schemas/ResponseMinimalEntityGroup"},"nullable":true,"type":"array"},"entityName":{"description":"The name of the entity associated with this alert.","type":"string"},"entityReviewState":{"$ref":"#/components/schemas/ResponseEntityReviewState"},"entityRiskScore":{"description":"The current risk score of the entity.","type":"integer"},"entityType":{"description":"The type that the entity was searched with","enum":["company","person","vessel","aircraft",""],"example":"company","type":"string"},"entityURN":{"description":"The URN of the entity associated with this alert. You can use the \"Retrieve an entity's current state\" endpoint with this value.","type":"string"},"id":{"description":"Unique identifier for the alert.","minimum":0,"type":"integer"},"origins":{"description":"A user-friendly list of where the entity was seen, e.g. in Monitoring entities, or in one-off searches.","items":{"type":"string"},"nullable":true,"type":"array"},"riskMetadata":{"$ref":"#/components/schemas/ResponseRiskMetadata"},"status":{"description":"Current status of the alert.","enum":["open","closed"],"type":"string"},"updatedAt":{"description":"When the alert was last updated, typically when new indicators were added.","format":"date-time","type":"string"}},"type":"object"},"ResponseBulkEntityUploadResponse":{"properties":{"taskID":{"type":"string"}},"type":"object"},"ResponseCaseManagementIntentPayload":{"properties":{"customFields":{"description":"User-provided metadata, any format. Does not affect matching, risk, or profile data.","items":{"$ref":"#/components/schemas/SigmaidCustomEntityField"},"nullable":true,"type":"array"},"customerKey":{"description":"A user-provided identifier. Any format.","example":"ABC1234567890","type":"string"},"entityLink":{"description":"The URL link for the specified entity","example":"https://app.sigma360.com/entity/123e4567-e89b-12d3-a456-426614174000","type":"string"},"entityURN":{"description":"The primary identifier for user-created entities","example":"urn:sigma:entity:123e4567-e89b-12d3-a456-426614174000","type":"string"},"indicatorSummaries":{"description":"The list of indicator summaries of the entity","items":{"$ref":"#/components/schemas/SigmaidIndicatorSummary"},"nullable":true,"type":"array"},"searchParameters":{"$ref":"#/components/schemas/SigmaidBasicSearchParams"}},"type":"object"},"ResponseCaseManagementIntentPing":{"properties":{"eventPayload":{"$ref":"#/components/schemas/ResponseCaseManagementIntentPayload"},"eventType":{"default":"sendToCaseManagementIntentPing","type":"string"}},"type":"object"},"ResponseChangedField":{"properties":{"after":{"items":{"$ref":"#/components/schemas/ResponseChangedItem"},"nullable":true,"type":"array"},"before":{"items":{"type":"string"},"nullable":true,"type":"array"},"field":{"type":"string"}},"type":"object"},"ResponseChangedItem":{"properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"ResponseConfigurationChanges":{"properties":{"dataChangeType":{"type":"string"},"dataChanges":{"items":{"$ref":"#/components/schemas/ResponseChangedField"},"nullable":true,"type":"array"}},"type":"object"},"ResponseDecisionState":{"properties":{"decidedByDefault":{"type":"boolean"},"decisionedAgainst":{"type":"boolean"},"hasDecision":{"type":"boolean"},"notes":{"type":"string"},"rationale":{"items":{"type":"string"},"nullable":true,"type":"array"},"reviewSubmittedAt":{"type":"string"},"reviewedByUserName":{"type":"string"},"reviewedByUserURN":{"type":"string"},"wasDecisionMadeAgainstThisVersion":{"type":"boolean"}},"type":"object"},"ResponseDecisionTimelineState":{"properties":{"decidedByDefault":{"type":"boolean"},"decisionedAgainst":{"type":"boolean"},"notes":{"type":"string"},"rationale":{"items":{"type":"string"},"nullable":true,"type":"array"},"reviewSubmittedAt":{"type":"string"},"reviewedByUserName":{"type":"string"},"reviewedByUserURN":{"type":"string"}},"type":"object"},"ResponseDecisionedNewsEvent":{"properties":{"articles":{"items":{"$ref":"#/components/schemas/SigmaidEventArticle"},"nullable":true,"type":"array"},"decisioning":{"$ref":"#/components/schemas/ResponseDecisionState"},"decisioningTimeline":{"items":{"$ref":"#/components/schemas/ResponseDecisionTimelineState"},"nullable":true,"type":"array"},"entityRisk":{"type":"string"},"eventConfidence":{"type":"number"},"eventLabel":{"type":"string"},"eventMaterialityScore":{"type":"number"},"eventSeverity":{"type":"string"},"humanVerified":{"type":"boolean"},"id":{"type":"string"},"isPreferredPublisher":{"type":"boolean"},"sigmaID":{"type":"string"},"topics":{"items":{"type":"string"},"nullable":true,"type":"array"},"unformattedLabel":{"type":"string"}},"type":"object"},"ResponseDiffNumber":{"properties":{"new":{"type":"integer"},"old":{"type":"integer"}},"type":"object"},"ResponseEntity":{"properties":{"archivedAt":{"description":"Not null if the entity has been archived. The time when the entity was archived","format":"date-time","nullable":true,"type":"string"},"createdAt":{"format":"date-time","type":"string"},"customFields":{"description":"User-provided metadata, any format. Does not affect matching, risk, or profile data.","items":{"$ref":"#/components/schemas/SigmaidCustomEntityField"},"nullable":true,"type":"array"},"customerKey":{"description":"Optional. A user-provided identifier that will be returned in alerts and monitoring. Any format.","example":"ABC1234567890","type":"string"},"dispositionState":{"$ref":"#/components/schemas/ResponseEntityDispositionState"},"entityGroups":{"items":{"$ref":"#/components/schemas/ResponseMinimalEntityGroup"},"nullable":true,"type":"array"},"entityName":{"example":"InGen Corporation","type":"string"},"entitySources":{"description":"Describes which job or action created the entity","items":{"$ref":"#/components/schemas/CommonEntitySource"},"nullable":true,"type":"array"},"entityType":{"description":"The resolved entity type","enum":["company","person","vessel","aircraft",""],"example":"company","nullable":true,"type":"string"},"escalated":{"type":"boolean"},"escalatedByUserName":{"nullable":true,"type":"string"},"escalatedByUserUrn":{"nullable":true,"type":"string"},"escalatedTime":{"format":"date-time","nullable":true,"type":"string"},"filterSetID":{"minimum":0,"type":"integer"},"filterSetName":{"example":"Investigative Due Diligence","type":"string"},"hasOpenAlert":{"description":"Whether the entity has an open alert","type":"boolean"},"indicatorSummaries":{"description":"The summary of the indicators that are currently active","items":{"$ref":"#/components/schemas/SigmaidIndicatorSummary"},"nullable":true,"type":"array"},"indicators":{"$ref":"#/components/schemas/ResponseIndicators"},"matches":{"$ref":"#/components/schemas/ResponseMatches"},"monitored":{"description":"Whether the entity will receive automated data and risk updates","example":true,"type":"boolean"},"notes":{"description":"The user-provided notes that have been added to the entity","items":{"$ref":"#/components/schemas/ResponseNote"},"nullable":true,"type":"array"},"organizationURN":{"description":"The primary identifier for the organization that owns the entity","example":"urn:sigma:organization:ingen-corp","type":"string"},"profile":{"$ref":"#/components/schemas/ResponseProfile"},"reviewState":{"$ref":"#/components/schemas/ResponseEntityReviewState"},"riskMetadata":{"$ref":"#/components/schemas/ResponseRiskMetadata"},"riskScore":{"description":"The risk from 0 to 100, where 0 is the lowest risk and 100 is the highest risk","example":50,"type":"integer"},"searchParameters":{"$ref":"#/components/schemas/ResponseSearchParameters"},"updatedAt":{"format":"date-time","type":"string"},"urn":{"description":"The primary identifier for user-created entities","example":"urn:sigma:entity:123e4567-e89b-12d3-a456-426614174000","type":"string"}},"type":"object"},"ResponseEntityDispositionChangePing":{"properties":{"eventPayload":{"$ref":"#/components/schemas/ResponseEntityDispositionWebhookPayload"},"eventType":{"default":"entityDispositionChangePing","type":"string"}},"type":"object"},"ResponseEntityDispositionState":{"properties":{"dispositionSetAtTime":{"description":"The time when the disposition was last set","example":"2020-01-01T00:00:00Z","format":"date-time","nullable":true,"type":"string"},"dispositionSetByUserName":{"description":"The name of the user who last set the disposition","example":"John Hammond","nullable":true,"type":"string"},"dispositionSetByUserURN":{"description":"The URN of the user who last set the disposition","example":"urn:sigma:user:f6ba1259b3a35de80aab7733c5d5","nullable":true,"type":"string"},"dispositionState":{"description":"The current disposition state of the entity. Should be unsnaked and titlecased before UI display","example":"pending","type":"string"}},"type":"object"},"ResponseEntityDispositionWebhookPayload":{"properties":{"customerKey":{"description":"A user-provided identifier. Any format.","example":"ABC1234567890","type":"string"},"entityURN":{"description":"The primary identifier for user-created entities","example":"urn:sigma:entity:123e4567-e89b-12d3-a456-426614174000","type":"string"},"newEntityDispositionState":{"description":"The new disposition state assigned to the entity","example":"pending","type":"string"},"timestamp":{"description":"The time when the disposition was changed","example":"2020-01-01T00:00:00Z","format":"date-time","nullable":true,"type":"string"},"userName":{"description":"The name of the user who changed the disposition","example":"John Hammond","type":"string"}},"type":"object"},"ResponseEntityGroup":{"properties":{"associatedEntitiesCount":{"description":"The number of entities present in this group","example":100,"type":"integer"},"associatedTeamsCount":{"description":"The number of teams which this groups belongs","example":2,"type":"integer"},"createdAt":{"format":"date-time","type":"string"},"entityGroupName":{"type":"string"},"id":{"minimum":0,"type":"integer"},"updatedAt":{"format":"date-time","type":"string"}},"type":"object"},"ResponseEntityGroups":{"properties":{"entityGroups":{"items":{"$ref":"#/components/schemas/ResponseEntityGroup"},"nullable":true,"type":"array"}},"type":"object"},"ResponseEntityHistory":{"properties":{"changedMatches":{"type":"integer"},"configurationChanges":{"$ref":"#/components/schemas/ResponseConfigurationChanges"},"currentSearchParams":{"$ref":"#/components/schemas/SigmaidBasicSearchParams"},"event":{"type":"string"},"externalDocumentLink":{"type":"string"},"historyID":{"minimum":0,"type":"integer"},"indicatorChanges":{"items":{"$ref":"#/components/schemas/ResponseIndicatorChange"},"nullable":true,"type":"array"},"indicatorChangesSummary":{"items":{"$ref":"#/components/schemas/ResponseIndicatorDiff"},"nullable":true,"type":"array"},"kycChanges":{"items":{"$ref":"#/components/schemas/ResponseKYCChange"},"nullable":true,"type":"array"},"matchChanges":{"items":{"$ref":"#/components/schemas/ResponseMatchChange"},"nullable":true,"type":"array"},"newsChanges":{"items":{"$ref":"#/components/schemas/ResponseNewsChange"},"nullable":true,"type":"array"},"numIndicators":{"$ref":"#/components/schemas/ResponseDiffNumber"},"numMatches":{"$ref":"#/components/schemas/ResponseDiffNumber"},"origin":{"type":"string"},"postEventSearchParams":{"$ref":"#/components/schemas/SigmaidBasicSearchParams"},"preEventSearchParams":{"$ref":"#/components/schemas/SigmaidBasicSearchParams"},"riskScore":{"$ref":"#/components/schemas/ResponseDiffNumber"},"timestamp":{"format":"date-time","type":"string"},"urn":{"type":"string"}},"type":"object"},"ResponseEntityHistoryPing":{"properties":{"eventPayload":{"$ref":"#/components/schemas/ResponseEntityHistory"},"eventType":{"default":"entity_history","type":"string"}},"type":"object"},"ResponseEntityReviewState":{"properties":{"isAllowedToEndReview":{"description":"Whether the current user is allowed to cancel / submit a review","example":false,"type":"boolean"},"isEditingLocked":{"description":"Whether the current user is allowed to change this entity","example":false,"type":"boolean"},"lastReviewDate":{"description":"Time of the last review submission","example":"2020-01-01T00:00:00Z","format":"date-time","nullable":true,"type":"string"},"reviewLockedByName":{"description":"The name of the user who locked the entity for review","example":"John Hammond","nullable":true,"type":"string"},"reviewLockedByURN":{"description":"The URN of the user who locked the entity for review","example":"urn:sigma:user:f6ba1259b3a35de80aab7733c5d5","nullable":true,"type":"string"},"reviewLockedSince":{"description":"The time when the entity was locked for review","example":"2020-01-01T00:00:00Z","format":"date-time","nullable":true,"type":"string"},"reviewStatus":{"enum":["no_review_necessary","needs_review","review_locked","reviewed"],"example":"needs_review","type":"string"},"unreviewedItems":{"$ref":"#/components/schemas/ResponseUnreviewedItems"}},"type":"object"},"ResponseEntitySummary":{"properties":{"archivedAt":{"description":"Not null if the entity has been archived. The time when the entity was archived","format":"date-time","nullable":true,"type":"string"},"createdAt":{"format":"date-time","type":"string"},"customFields":{"description":"User-provided metadata, any format. Does not affect matching, risk, or profile data.","items":{"$ref":"#/components/schemas/SigmaidCustomEntityField"},"nullable":true,"type":"array"},"customerKey":{"description":"Optional. A user-provided identifier that will be returned in alerts and monitoring. Any format.","example":"ABC1234567890","type":"string"},"dispositionState":{"$ref":"#/components/schemas/ResponseEntityDispositionState"},"entityGroups":{"items":{"$ref":"#/components/schemas/ResponseMinimalEntityGroup"},"nullable":true,"type":"array"},"entityName":{"example":"InGen Corporation","type":"string"},"entitySources":{"description":"Describes which job or action created the entity","items":{"$ref":"#/components/schemas/CommonEntitySource"},"nullable":true,"type":"array"},"entityType":{"description":"The resolved entity type","enum":["company","person","vessel","aircraft",""],"example":"company","nullable":true,"type":"string"},"escalated":{"type":"boolean"},"escalatedByUserName":{"nullable":true,"type":"string"},"escalatedByUserUrn":{"nullable":true,"type":"string"},"escalatedTime":{"format":"date-time","nullable":true,"type":"string"},"filterSetID":{"minimum":0,"type":"integer"},"filterSetName":{"example":"Investigative Due Diligence","type":"string"},"hasOpenAlert":{"description":"Whether the entity has an open alert","type":"boolean"},"indicatorSummaries":{"description":"The summary of the indicators that are currently active","items":{"$ref":"#/components/schemas/SigmaidIndicatorSummary"},"nullable":true,"type":"array"},"monitored":{"description":"Whether the entity will receive automated data and risk updates","example":true,"type":"boolean"},"notes":{"description":"The user-provided notes that have been added to the entity","items":{"$ref":"#/components/schemas/ResponseNote"},"nullable":true,"type":"array"},"organizationURN":{"description":"The primary identifier for the organization that owns the entity","example":"urn:sigma:organization:ingen-corp","type":"string"},"reviewState":{"$ref":"#/components/schemas/ResponseEntityReviewState"},"riskMetadata":{"$ref":"#/components/schemas/ResponseRiskMetadata"},"riskScore":{"description":"The risk from 0 to 100, where 0 is the lowest risk and 100 is the highest risk","example":50,"type":"integer"},"searchParameters":{"$ref":"#/components/schemas/SigmaidBasicSearchParams"},"updatedAt":{"format":"date-time","type":"string"},"urn":{"description":"The primary identifier for user-created entities","example":"urn:sigma:entity:123e4567-e89b-12d3-a456-426614174000","type":"string"}},"type":"object"},"ResponseEventSummary":{"properties":{"eventType":{"type":"string"},"numArticles":{"type":"integer"},"numEvents":{"type":"integer"},"unformattedEventType":{"type":"string"}},"type":"object"},"ResponseFacetInfo":{"properties":{"aircraft":{"$ref":"#/components/schemas/SigmaidFacetAircraft"},"company":{"$ref":"#/components/schemas/SigmaidFacetCompany"},"person":{"$ref":"#/components/schemas/SigmaidFacetPerson"},"vessel":{"$ref":"#/components/schemas/SigmaidFacetVessel"}},"type":"object"},"ResponseFullSearchResultWithAlertPubliclyDocumented":{"properties":{"alertCreatedURN":{"description":"Populated if the search resulted in an alert being created. Contains the URN of the alert. Only valid if using createAlerts=true in the request.","type":"string"},"resultCount":{"description":"Number of individual matches found","example":2,"type":"integer"},"resultRows":{"items":{"$ref":"#/components/schemas/SigmaidCompositeResult"},"nullable":true,"type":"array"},"searchDate":{"example":"2023-01-01T00:00:00Z","format":"date-time","type":"string"}},"required":["resultCount","resultRows","searchDate"],"type":"object"},"ResponseIndicator":{"properties":{"category":{"example":"Sanctions","type":"string"},"causalSigmaID":{"$ref":"#/components/schemas/SigmaidSummarySearchResultRow"},"code":{"example":"SAN006","type":"string"},"date":{"example":"2023-01-01T00:00:00Z","format":"date-time","nullable":true,"type":"string"},"decisioning":{"$ref":"#/components/schemas/ResponseDecisionState"},"decisioningTimeline":{"items":{"$ref":"#/components/schemas/ResponseDecisionTimelineState"},"nullable":true,"type":"array"},"description":{"example":"Swiss State Secretariat for Economic Affairs","type":"string"},"extras":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Extra details about the indicator","nullable":true,"type":"object"},"hopsAway":{"example":0,"type":"integer"},"name":{"example":"Appears on sanction list","type":"string"},"originatingSigmaID":{"type":"string"},"primaryExtras":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Extra details about the indicator, typical shown above the fold","nullable":true,"type":"object"},"relationshipChain":{"$ref":"#/components/schemas/SigmaidRelationshipChain"},"score":{"example":90,"type":"integer"},"sourceAttribution":{"description":"Not human readable. This can be used to look up against source information objects.","items":{"example":"abcd1234//1234567890","type":"string"},"nullable":true,"type":"array"},"sources":{"items":{"$ref":"#/components/schemas/SigmaidSourceURL"},"nullable":true,"type":"array"},"subcategory":{"example":"sanctions_swiss","type":"string"},"urn":{"example":"urn:sigma:indicator:5VpYSbsw2R6UaVxFilHv_TpJ5wJZocEzMAaLvFkVJAg=","type":"string"}},"required":["urn","code","name","category","subcategory","hopsAway","sources","description"],"type":"object"},"ResponseIndicatorChange":{"properties":{"category":{"example":"Sanctions","type":"string"},"causalSigmaID":{"$ref":"#/components/schemas/SigmaidSummarySearchResultRow"},"changeType":{"type":"string"},"code":{"example":"SAN006","type":"string"},"dataChanges":{"items":{"$ref":"#/components/schemas/ResponseChangedField"},"nullable":true,"type":"array"},"date":{"example":"2023-01-01T00:00:00Z","format":"date-time","nullable":true,"type":"string"},"decisioning":{"$ref":"#/components/schemas/ResponseDecisionState"},"decisioningTimeline":{"items":{"$ref":"#/components/schemas/ResponseDecisionTimelineState"},"nullable":true,"type":"array"},"description":{"example":"Swiss State Secretariat for Economic Affairs","type":"string"},"extras":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Extra details about the indicator","nullable":true,"type":"object"},"hopsAway":{"example":0,"type":"integer"},"name":{"example":"Appears on sanction list","type":"string"},"originatingSigmaID":{"type":"string"},"possibleSameAs":{"type":"string"},"primaryExtras":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Extra details about the indicator, typical shown above the fold","nullable":true,"type":"object"},"relationshipChain":{"$ref":"#/components/schemas/SigmaidRelationshipChain"},"score":{"example":90,"type":"integer"},"sourceAttribution":{"description":"Not human readable. This can be used to look up against source information objects.","items":{"example":"abcd1234//1234567890","type":"string"},"nullable":true,"type":"array"},"sources":{"items":{"$ref":"#/components/schemas/SigmaidSourceURL"},"nullable":true,"type":"array"},"subcategory":{"example":"sanctions_swiss","type":"string"},"urn":{"example":"urn:sigma:indicator:5VpYSbsw2R6UaVxFilHv_TpJ5wJZocEzMAaLvFkVJAg=","type":"string"}},"required":["urn","code","name","category","subcategory","hopsAway","sources","description"],"type":"object"},"ResponseIndicatorDiff":{"properties":{"added":{"type":"integer"},"category":{"type":"string"},"deleted":{"type":"integer"},"isNetwork":{"type":"boolean"},"maxScore":{"type":"integer"},"updated":{"type":"integer"}},"type":"object"},"ResponseIndicators":{"properties":{"acceptedRisks":{"description":"The risk indicators that have been accepted by a user in your organization. These are not considered for risk score calculation.","items":{"$ref":"#/components/schemas/ResponseIndicator"},"nullable":true,"type":"array"},"activeRisks":{"description":"The active risk indicators that are currently influencing the entity risk score.","items":{"$ref":"#/components/schemas/ResponseIndicator"},"nullable":true,"type":"array"},"risksRequiringReview":{"description":"Used only for user-review-enabled clients. Indicators that have been escalated for review, but have not yet been reviewed.","items":{"$ref":"#/components/schemas/ResponseIndicator"},"type":"array"}},"type":"object"},"ResponseKYCChange":{"properties":{"changeType":{"type":"string"},"dataChanges":{"items":{"$ref":"#/components/schemas/ResponseChangedField"},"nullable":true,"type":"array"},"sigmaID":{"type":"string"}},"type":"object"},"ResponseMatch":{"properties":{"aliases":{"items":{"example":"InGen Corp.","type":"string"},"nullable":true,"type":"array"},"birthDates":{"description":"Birth dates of the entity","items":{"$ref":"#/components/schemas/SigmaidDateWithSource"},"nullable":true,"type":"array"},"decisioning":{"$ref":"#/components/schemas/ResponseDecisionState"},"decisioningTimeline":{"items":{"$ref":"#/components/schemas/ResponseDecisionTimelineState"},"nullable":true,"type":"array"},"entityName":{"example":"InGen Corporation","type":"string"},"entityType":{"example":"company","nullable":true,"type":"string"},"foundationDates":{"description":"Foundation dates of the entity","items":{"$ref":"#/components/schemas/SigmaidDateWithSource"},"nullable":true,"type":"array"},"genders":{"description":"Listed genders of the entity","items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"identifiers":{"description":"Identification numbers of the entity","items":{"$ref":"#/components/schemas/SigmaidIdentification"},"nullable":true,"type":"array"},"indicatorSummaries":{"items":{"$ref":"#/components/schemas/SigmaidIndicatorSummary"},"nullable":true,"type":"array"},"locations":{"items":{"$ref":"#/components/schemas/SigmaidLocation"},"nullable":true,"type":"array"},"matchDOB":{"description":"The match date from your search date of birth and date of birth proximity","example":"1948-01-15T00:00:00Z","type":"string"},"matchLocation":{"description":"The match location from your search countries and location proximity","example":"us","type":"string"},"matchName":{"description":"The alias or name that was most similar to your search term","type":"string"},"matchStrength":{"description":"The match strength of the matchName to your search term","example":0.8,"type":"number"},"riskMetadata":{"$ref":"#/components/schemas/ResponseRiskMetadata"},"riskScore":{"type":"number"},"sigmaID":{"example":"3BX869NCJTZ5K","type":"string"}},"type":"object"},"ResponseMatchChange":{"properties":{"birthOrFoundationDates":{"items":{"format":"date-time","type":"string"},"nullable":true,"type":"array"},"changeType":{"type":"string"},"entityName":{"type":"string"},"locations":{"items":{"$ref":"#/components/schemas/SigmaidLocation"},"nullable":true,"type":"array"},"sigmaID":{"type":"string"}},"type":"object"},"ResponseMatchSummary":{"properties":{"highestEntityRisk":{"type":"string"},"matchName":{"type":"string"},"numEvents":{"type":"integer"},"yearOfBirth":{"nullable":true,"type":"integer"}},"type":"object"},"ResponseMatches":{"properties":{"matchesRequiringReview":{"description":"Used only for user-review-enabled clients. Matches that have been escalated for review, but have not yet been reviewed.","items":{"$ref":"#/components/schemas/ResponseMatch"},"type":"array"},"negativelyDecisionedMatches":{"description":"Matches that a user in your organization has marked as not a valid match. These are not considered for risk, indicators, and profile data in the entity.","items":{"$ref":"#/components/schemas/ResponseMatch"},"nullable":true,"type":"array"},"trueMatches":{"description":"Matches that are in-force for this entity. These influence risk, indicators, and profile data.","items":{"$ref":"#/components/schemas/ResponseMatch"},"nullable":true,"type":"array"}},"type":"object"},"ResponseMinimalEntityGroup":{"properties":{"entityGroupName":{"type":"string"},"id":{"minimum":0,"type":"integer"}},"type":"object"},"ResponseNews":{"properties":{"newsEvents":{"items":{"$ref":"#/components/schemas/ResponseDecisionedNewsEvent"},"nullable":true,"type":"array"},"page":{"description":"Page number, 1-indexed. Default: 1","example":1,"type":"integer"},"pageSize":{"description":"Number of results per page. Maximum: 100, Default: 10","example":10,"type":"integer"},"summary":{"$ref":"#/components/schemas/ResponseNewsSummary"},"total":{"description":"Total number of results. Ignored in requests, used in responses.","example":15000,"type":"integer"}},"type":"object"},"ResponseNewsChange":{"properties":{"articles":{"items":{"$ref":"#/components/schemas/SigmaidEventArticle"},"nullable":true,"type":"array"},"changeType":{"type":"string"},"dataChanges":{"items":{"$ref":"#/components/schemas/ResponseChangedField"},"nullable":true,"type":"array"},"decisioning":{"$ref":"#/components/schemas/ResponseDecisionState"},"decisioningTimeline":{"items":{"$ref":"#/components/schemas/ResponseDecisionTimelineState"},"nullable":true,"type":"array"},"entityRisk":{"type":"string"},"eventConfidence":{"type":"number"},"eventLabel":{"type":"string"},"eventMaterialityScore":{"type":"number"},"eventSeverity":{"type":"string"},"humanVerified":{"type":"boolean"},"id":{"type":"string"},"isPreferredPublisher":{"type":"boolean"},"sigmaID":{"type":"string"},"topics":{"items":{"type":"string"},"nullable":true,"type":"array"},"unformattedLabel":{"type":"string"}},"type":"object"},"ResponseNewsMetadata":{"properties":{"count":{"description":"The number of news events for this type that are currently detected","example":3,"type":"integer"},"eventNewsType":{"description":"The event news type currently detected","example":"Legal Risk","type":"string"},"samplePublishers":{"description":"A sample of the publishers that are currently detected","items":{"example":"The New York Times","type":"string"},"nullable":true,"type":"array"},"unformattedEventNewsType":{"description":"The unformatted event news type currently detected","example":"legal_risk","type":"string"}},"type":"object"},"ResponseNewsSummary":{"properties":{"eventEntityRisks":{"items":{"type":"string"},"nullable":true,"type":"array"},"eventsSummary":{"items":{"$ref":"#/components/schemas/ResponseEventSummary"},"nullable":true,"type":"array"},"languages":{"items":{"type":"string"},"nullable":true,"type":"array"},"matchNames":{"items":{"type":"string"},"nullable":true,"type":"array"},"matchesSummary":{"items":{"$ref":"#/components/schemas/ResponseMatchSummary"},"nullable":true,"type":"array"},"publisherCountries":{"items":{"type":"string"},"nullable":true,"type":"array"},"publisherRegions":{"items":{"type":"string"},"nullable":true,"type":"array"},"publisherSubRegions":{"items":{"type":"string"},"nullable":true,"type":"array"},"territories":{"items":{"type":"string"},"nullable":true,"type":"array"},"yearsOfBirth":{"items":{"type":"integer"},"nullable":true,"type":"array"}},"type":"object"},"ResponseNote":{"properties":{"entityUrn":{"type":"string"},"id":{"minimum":0,"type":"integer"},"note":{"type":"string"},"updatedAt":{"format":"date-time","type":"string"},"userName":{"type":"string"},"userUrn":{"type":"string"}},"type":"object"},"ResponsePaginatedEntityHistory":{"properties":{"histories":{"items":{"$ref":"#/components/schemas/ResponseEntityHistory"},"nullable":true,"type":"array"},"page":{"type":"integer"},"pageSize":{"type":"integer"},"total":{"type":"integer"}},"type":"object"},"ResponsePaginatedEntitySummaries":{"properties":{"entities":{"items":{"$ref":"#/components/schemas/ResponseEntitySummary"},"nullable":true,"type":"array"},"page":{"description":"Page number, 1-indexed. Default: 1","example":1,"type":"integer"},"pageSize":{"description":"Number of results per page. Maximum: 100, Default: 10","example":10,"type":"integer"},"total":{"description":"Total number of results. Ignored in requests, used in responses.","example":15000,"type":"integer"}},"type":"object"},"ResponsePaginatedFullEntities":{"properties":{"entities":{"description":"The list of entities that were found for the search parameters","items":{"$ref":"#/components/schemas/ResponseEntity"},"nullable":true,"type":"array"},"page":{"description":"Page number, 1-indexed. Default: 1","example":1,"type":"integer"},"pageSize":{"description":"Number of results per page. Maximum: 100, Default: 10","example":10,"type":"integer"},"total":{"description":"Total number of results. Ignored in requests, used in responses.","example":15000,"type":"integer"}},"type":"object"},"ResponseProfile":{"properties":{"facet":{"$ref":"#/components/schemas/ResponseFacetInfo"},"kyc":{"$ref":"#/components/schemas/SigmaidKYCEntityData"}},"type":"object"},"ResponseProfileInformationByMatch":{"properties":{"aliases":{"items":{"type":"string"},"type":"array"},"aliasesWithSources":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"type":"array"},"corporateNumbers":{"items":{"$ref":"#/components/schemas/SigmaidCorporateNumber"},"nullable":true,"type":"array"},"dobs":{"items":{"$ref":"#/components/schemas/SigmaidDateWithSource"},"nullable":true,"type":"array"},"economicActivities":{"additionalProperties":{"items":{"$ref":"#/components/schemas/SigmaidEconomicActivity"},"type":"array"},"nullable":true,"type":"object"},"facetType":{"type":"string"},"facts":{"items":{"$ref":"#/components/schemas/SigmaidFact"},"type":"array"},"foundedDates":{"items":{"$ref":"#/components/schemas/SigmaidDateWithSource"},"nullable":true,"type":"array"},"genders":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"identifications":{"items":{"$ref":"#/components/schemas/SigmaidIdentification"},"nullable":true,"type":"array"},"imo":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"incorporationTypes":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"linesOfBusiness":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"locations":{"items":{"$ref":"#/components/schemas/SigmaidLocation"},"type":"array"},"manufactureDates":{"items":{"$ref":"#/components/schemas/SigmaidDateWithSource"},"nullable":true,"type":"array"},"maritimeCallSigns":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"models":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"nationalities":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"operators":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"otherIdentifiers":{"items":{"$ref":"#/components/schemas/SigmaidIdentification"},"nullable":true,"type":"array"},"politicalPositions":{"items":{"$ref":"#/components/schemas/SigmaidPoliticalPosition"},"nullable":true,"type":"array"},"portsOfRegistry":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"serialNumbers":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"sigmaID":{"type":"string"},"statuses":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"tailNumbers":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"types":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"}},"type":"object"},"ResponseRiskMetadata":{"properties":{"newsMetadata":{"description":"The news events that are currently detected","items":{"$ref":"#/components/schemas/ResponseNewsMetadata"},"nullable":true,"type":"array"},"pepLevels":{"description":"The PEP levels that are currently detected","items":{"example":"PEP Level 1","type":"string"},"nullable":true,"type":"array"},"sanctionLists":{"description":"The sanction lists that are currently detected","items":{"example":"sanctions_ofac","type":"string"},"nullable":true,"type":"array"}},"type":"object"},"ResponseSearchParameters":{"properties":{"aliases":{"items":{"example":"Ingen Corp.","type":"string"},"nullable":true,"type":"array"},"countries":{"items":{"example":"CR","type":"string"},"nullable":true,"type":"array"},"dob":{"nullable":true,"type":"string"},"entityType":{"example":"company","type":"string"}},"type":"object"},"ResponseStatus":{"properties":{"success":{"description":"Indicates if the request was successful","type":"boolean"}},"type":"object"},"ResponseTaskCompletionReport":{"properties":{"apiKey":{"type":"string"},"numEntities":{"type":"integer"},"success":{"type":"boolean"},"taskID":{"type":"string"}},"type":"object"},"ResponseTaskCompletionReportPing":{"properties":{"eventPayload":{"$ref":"#/components/schemas/ResponseTaskCompletionReport"},"eventType":{"default":"task_completion","type":"string"}},"type":"object"},"ResponseTaskProgress":{"properties":{"createdAt":{"format":"date-time","type":"string"},"entityGroupNames":{"items":{"type":"string"},"nullable":true,"type":"array"},"id":{"type":"string"},"taskStatus":{"default":"Working","enum":["Working","Done","Failed"],"type":"string"},"totalEntities":{"type":"integer"}},"type":"object"},"ResponseUnreviewedItems":{"properties":{"numIndicators":{"description":"The number of indicators inside the entity that require review","example":5,"type":"integer"},"numMatches":{"description":"The number of matches inside the entity that require review","example":2,"type":"integer"},"numNews":{"description":"The number of news events inside the entity that require review","example":16,"type":"integer"},"total":{"description":"The number of items inside the entity that require review","example":3,"type":"integer"}},"type":"object"},"ResponseWebhookTestEndpointResponse":{"properties":{"message":{"description":"Status message. Use the response code to determine success or failure.","example":"Test webhook message sent successfully","type":"string"},"orgID":{"description":"The ID of the organization that owns the webhook.","example":"my-company","type":"string"}},"type":"object"},"SigmaidBasicEntityResult":{"properties":{"entityName":{"example":"InGen Corporation","type":"string"},"entityType":{"example":"company","type":"string"},"sigmaID":{"example":"3BX869NCJTZ5K","type":"string"}},"type":"object"},"SigmaidBasicSearchParams":{"properties":{"aliases":{"description":"Secondary names to perform a search on","items":{"example":"InGen, InGen Corp","type":"string"},"nullable":true,"type":"array"},"countries":{"description":"ISO 3166-1 alpha-2","items":{"example":"US","type":"string"},"nullable":true,"type":"array"},"customFields":{"description":"Optional. A list of custom fields to be associated with the entity for cross-referencing or disambiguation in alerts and monitoring. Does not affecting risk or matching logic. Each field must have a unique key.","items":{"$ref":"#/components/schemas/SigmaidCustomEntityField"},"nullable":true,"type":"array"},"customerKey":{"description":"Optional. A user-provided identifier that will be returned in alerts and monitoring. Any format.","example":"ABC1234567890","type":"string"},"dob":{"description":"Birth or foundation date. YYYY, YYYY-MM, YYYY-MM-DD, YYYY/MM or YYYY/MM/DD format.","example":"1993-06-11","nullable":true,"type":"string"},"entityName":{"description":"The primary name of the search","example":"InGen Corporation","type":"string"},"entityType":{"enum":["person","company","aircraft","vessel"],"example":"company","nullable":true,"type":"string"}},"required":["entityName"],"type":"object"},"SigmaidCompositeResult":{"properties":{"entity":{"$ref":"#/components/schemas/SigmaidEntityResult"},"matchDOB":{"type":"string"},"matchLocation":{"type":"string"},"matchName":{"example":"InGen Corporation","type":"string"},"matchStrength":{"example":0.95,"type":"number"},"networkRiskSummary":{"$ref":"#/components/schemas/SigmaidNetworkRiskResult"},"sources":{"items":{"$ref":"#/components/schemas/SigmaidSourcesByIntegration"},"nullable":true,"type":"array"}},"required":["entity"],"type":"object"},"SigmaidCorporateNumber":{"properties":{"country":{"items":{"type":"string"},"nullable":true,"type":"array"},"number":{"type":"string"},"register":{"items":{"type":"string"},"nullable":true,"type":"array"},"sourceAttribution":{"description":"Not human readable. This can be used to look up against source information objects.","items":{"example":"abcd1234//1234567890","type":"string"},"nullable":true,"type":"array"}},"type":"object"},"SigmaidCustomEntityField":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"},"SigmaidDataSourcesResponse":{"properties":{"rawDataSources":{"additionalProperties":{"$ref":"#/components/schemas/SigmaidIntegrationInfo"},"nullable":true,"type":"object"},"reportDataSources":{"additionalProperties":{"$ref":"#/components/schemas/SigmaidIntegrationLastUpdated"},"nullable":true,"type":"object"},"reportDataSourcesBuckets":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"nullable":true,"type":"object"}},"type":"object"},"SigmaidDateWithSource":{"properties":{"humanReadable":{"description":"A human-readable representation of the range. Show in user interfaces instead of the date range if present","example":"Circa 1980","nullable":true,"type":"string"},"sourceAttribution":{"description":"Not human readable. This can be used to look up against source information objects.","items":{"example":"abcd1234//1234567890","type":"string"},"nullable":true,"type":"array"},"until":{"description":"If the date is a range, the end of the range","example":"2023-01-01T00:00:00Z","format":"date-time","nullable":true,"type":"string"},"value":{"description":"The date, or the start of a date range","example":"2023-01-01T00:00:00Z","format":"date-time","type":"string"}},"type":"object"},"SigmaidEconomicActivity":{"properties":{"code":{"type":"string"},"label":{"type":"string"},"sourceAttribution":{"description":"Not human readable. This can be used to look up against source information objects.","items":{"example":"abcd1234//1234567890","type":"string"},"nullable":true,"type":"array"}},"type":"object"},"SigmaidEdge":{"properties":{"edgeID":{"description":"A unique identifier for this edge.","type":"string"},"extendedRelationshipData":{"$ref":"#/components/schemas/SigmaidExtendedRelationshipData"},"fromNode":{"description":"The SigmaID of the node that this edge starts from.","type":"string"},"inverseRelationship":{"description":"The normalized relationship in the inverse direction.","example":"Is Subsidiary Of","type":"string"},"relationship":{"description":"The normalized relationship, as determined by SigmaID's NLP models.","example":"Has Subsidiary","type":"string"},"relationshipDenotesOwnership":{"description":"Whether this relationship imparts ownership or control. For example, 'Has Subsidiary' would have this field set to true, while 'Is Officer Of'' would have it set to false.","type":"boolean"},"toNode":{"description":"The SigmaID of the node that this edge points to.","type":"string"},"unnormalizedRelationship":{"description":"The raw text of the relationship as it appears in the source data.","type":"string"}},"type":"object"},"SigmaidEntityResult":{"properties":{"KYC":{"$ref":"#/components/schemas/SigmaidKYCEntityData"},"entityName":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"facet":{"$ref":"#/components/schemas/SigmaidFullEntityFacet"},"indicatorSummaries":{"items":{"$ref":"#/components/schemas/SigmaidIndicatorSummary"},"type":"array"},"indicators":{"items":{"$ref":"#/components/schemas/SigmaidIndicator"},"nullable":true,"type":"array"},"news":{"items":{"$ref":"#/components/schemas/SigmaidNewsEvent"},"nullable":true,"type":"array"},"riskSummary":{"$ref":"#/components/schemas/SigmaidRiskSummary"},"sigmaID":{"type":"string"}},"required":["sigmaID","riskSummary","indicatorSummaries","entityName","KYC","news","indicators","facet"],"type":"object"},"SigmaidEventArticle":{"properties":{"articleHash":{"type":"string"},"body":{"description":"The full-text article body, if available","type":"string"},"extractedEntities":{"description":"Detected entities and highlights from the article body/title. This can be natural persons or entities.","items":{"$ref":"#/components/schemas/SigmaidExtractEntity"},"nullable":true,"type":"array"},"extractedRisks":{"description":"Highlight information for risky keywords or phrases in the article or title.","items":{"$ref":"#/components/schemas/SigmaidExtractedRisk"},"type":"array"},"extractedTerritories":{"description":"Countries and major administrative divisions (e.g., states, provinces) mentioned in the article.","items":{"$ref":"#/components/schemas/SigmaidExtractedTerritory"},"nullable":true,"type":"array"},"humanVerified":{"description":"A small portion of articles have been manually verified by Sigma360 analysts, this field indicates whether the article has been verified adverse or not","type":"boolean"},"isPreferredPublisher":{"description":"High-quality government gazettes, newspapers of record, or reputable news agencies are listed as preferred publishers. This field indicates whether the article is from a preferred publisher","type":"boolean"},"language":{"description":"The ISO 639-1 two-letter language code of the article","type":"string"},"materialityScore":{"description":"A ranking of how severe the event is, based on the article text. This is a number between 0 and 1, where 1 is the most severe.","type":"number"},"publishedDate":{"description":"The date and time the article was published, in ISO 8601 format","format":"date-time","type":"string"},"publisher":{"description":"A human-readable name of the publisher","example":"New York Times","type":"string"},"publisherCountryCode":{"description":"The ISO 3166-1 alpha-2 country code of the publisher's country. This is not the country of the event or journalist, but the country of the publisher's headquarters","type":"string"},"title":{"description":"The article title","type":"string"},"topics":{"description":"A list of detected event topics, such as 'white_collar_crime'","items":{"type":"string"},"nullable":true,"type":"array"},"url":{"description":"The article URL","type":"string"}},"type":"object"},"SigmaidExtendedRelationshipData":{"properties":{"asOfDate":{"description":"The date this relationship data was reported as of.","type":"string"},"currency":{"description":"The currency of the monetary value.","type":"string"},"endDate":{"description":"The date this relationship ended.","type":"string"},"former":{"description":"Whether this relationship is no longer active.","type":"boolean"},"monetaryValue":{"description":"The monetary value associated with this relationship.","type":"string"},"numShares":{"description":"The number of shares held in this relationship.","type":"string"},"percent":{"description":"The ownership or control percentage associated with this relationship.","type":"string"},"startDate":{"description":"The date this relationship began.","type":"string"},"ultimateSources":{"description":"The original data sources for this relationship.","items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"},"SigmaidExtractEntity":{"properties":{"entityRisk":{"description":"A measure of how culpable or involved the entity is in the event, based on the article text. Possible values are: 'Very High', 'High', 'Possible', 'Low', 'Unlikely', and 'Undetermined'.","type":"string"},"focalEntity":{"description":"Marks if this extracted entity is the main entity of its event. Events have one focal entity, but articles may appear in different events with different focal entities.'","type":"boolean"},"highlights":{"description":"Offsets of where the entity appears in the article body or title","items":{"$ref":"#/components/schemas/SigmaidHighLightSection"},"type":"array"},"labels":{"description":"Predicted entity types: PER, ORG, LOC, or MISC.","items":{"type":"string"},"nullable":true,"type":"array"},"text":{"description":"The entity name detected in the article body","type":"string"},"yearsOfBirth":{"description":"Birthdays of entities, if detected. This is a list of years, not a range.","items":{"type":"integer"},"nullable":true,"type":"array"}},"type":"object"},"SigmaidExtractedRisk":{"properties":{"category":{"type":"string"},"highlights":{"description":"Offsets of where the entity appears in the article body or title","items":{"$ref":"#/components/schemas/SigmaidHighLightSection"},"type":"array"}},"type":"object"},"SigmaidExtractedTerritory":{"properties":{"adminOne":{"description":"The first-level administrative division of the territory, if applicable. For example, a state in the US or a province in Canada.","nullable":true,"type":"string"},"count":{"description":"The amount of times this territory was mentioned in the article","type":"integer"},"country":{"description":"The ISO 3166-1 alpha-2 country code of the territory","type":"string"},"evidence":{"description":"The snippets of the article that support a territory determination","items":{"type":"string"},"nullable":true,"type":"array"},"highlights":{"description":"Offsets of where the entity appears in the article body or title","items":{"$ref":"#/components/schemas/SigmaidHighLightSection"},"type":"array"}},"type":"object"},"SigmaidFacetAircraft":{"properties":{"manufactureDates":{"items":{"$ref":"#/components/schemas/SigmaidDateWithSource"},"nullable":true,"type":"array"},"models":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"operators":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"otherIdentifiers":{"items":{"$ref":"#/components/schemas/SigmaidIdentification"},"nullable":true,"type":"array"},"serialNumbers":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"tailNumbers":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"}},"type":"object"},"SigmaidFacetCompany":{"properties":{"corporateNumbers":{"items":{"$ref":"#/components/schemas/SigmaidCorporateNumber"},"nullable":true,"type":"array"},"economicActivities":{"additionalProperties":{"items":{"$ref":"#/components/schemas/SigmaidEconomicActivity"},"type":"array"},"nullable":true,"type":"object"},"foundedDates":{"items":{"$ref":"#/components/schemas/SigmaidDateWithSource"},"nullable":true,"type":"array"},"incorporationTypes":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"linesOfBusiness":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"statuses":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"}},"type":"object"},"SigmaidFacetPerson":{"properties":{"dobs":{"items":{"$ref":"#/components/schemas/SigmaidDateWithSource"},"nullable":true,"type":"array"},"genders":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"identifications":{"items":{"$ref":"#/components/schemas/SigmaidIdentification"},"nullable":true,"type":"array"},"nationalities":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"politicalPositions":{"items":{"$ref":"#/components/schemas/SigmaidPoliticalPosition"},"nullable":true,"type":"array"}},"type":"object"},"SigmaidFacetVessel":{"properties":{"imo":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"maritimeCallSigns":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"portsOfRegistry":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"types":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"}},"type":"object"},"SigmaidFact":{"properties":{"label":{"example":"Notes","type":"string"},"sourceAttribution":{"description":"Not human readable. This can be used to look up against source information objects.","items":{"example":"abcd1234//1234567890","type":"string"},"nullable":true,"type":"array"},"value":{"example":"\u003ctext\u003e","type":"string"}},"type":"object"},"SigmaidFullEntityFacet":{"properties":{"aircraft":{"$ref":"#/components/schemas/SigmaidFacetAircraft"},"company":{"$ref":"#/components/schemas/SigmaidFacetCompany"},"person":{"$ref":"#/components/schemas/SigmaidFacetPerson"},"type":{"type":"integer"},"vessel":{"$ref":"#/components/schemas/SigmaidFacetVessel"}},"type":"object"},"SigmaidHighLightSection":{"properties":{"end":{"description":"The end of the detected entity name in the article. Relative to the beginning of the text.","type":"integer"},"start":{"description":"The beginning offset of the detected entity name in the article. Relative to the beginning of the text.","type":"integer"},"target":{"description":"Determines whether the offsets should be applied to the title or body.","enum":["title","body"],"type":"string"}},"type":"object"},"SigmaidIdentification":{"properties":{"country":{"nullable":true,"type":"string"},"extras":{"additionalProperties":{"type":"string"},"nullable":true,"type":"object"},"label":{"type":"string"},"sourceAttribution":{"description":"Not human readable. This can be used to look up against source information objects.","items":{"example":"abcd1234//1234567890","type":"string"},"nullable":true,"type":"array"},"value":{"type":"string"}},"type":"object"},"SigmaidIndicator":{"properties":{"category":{"example":"Sanctions","type":"string"},"causalSigmaID":{"$ref":"#/components/schemas/SigmaidSummarySearchResultRow"},"code":{"example":"SAN006","type":"string"},"date":{"example":"2023-01-01T00:00:00Z","format":"date-time","nullable":true,"type":"string"},"description":{"example":"Swiss State Secretariat for Economic Affairs","type":"string"},"extras":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Extra details about the indicator","nullable":true,"type":"object"},"hopsAway":{"example":0,"type":"integer"},"name":{"example":"Appears on sanction list","type":"string"},"originatingSigmaID":{"type":"string"},"primaryExtras":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Extra details about the indicator, typical shown above the fold","nullable":true,"type":"object"},"relationshipChain":{"$ref":"#/components/schemas/SigmaidRelationshipChain"},"score":{"example":90,"type":"integer"},"sourceAttribution":{"description":"Not human readable. This can be used to look up against source information objects.","items":{"example":"abcd1234//1234567890","type":"string"},"nullable":true,"type":"array"},"sources":{"items":{"$ref":"#/components/schemas/SigmaidSourceURL"},"nullable":true,"type":"array"},"subcategory":{"example":"sanctions_swiss","type":"string"},"urn":{"example":"urn:sigma:indicator:5VpYSbsw2R6UaVxFilHv_TpJ5wJZocEzMAaLvFkVJAg=","type":"string"}},"required":["urn","code","name","category","subcategory","hopsAway","sources","description"],"type":"object"},"SigmaidIndicatorSummary":{"properties":{"category":{"example":"Sanctions","type":"string"},"count":{"example":2,"type":"integer"},"isNetwork":{"description":"Indicates whether the indicator is describes this entity or one of its network connections","example":false,"type":"boolean"},"maxScore":{"example":100,"type":"integer"}},"type":"object"},"SigmaidIntegrationInfo":{"properties":{"firstIngestedDate":{"format":"date-time","type":"string"},"key":{"type":"string"},"lastRunDate":{"format":"date-time","type":"string"}},"type":"object"},"SigmaidIntegrationLastUpdated":{"properties":{"lastUpdated":{"format":"date-time","type":"string"}},"type":"object"},"SigmaidKYCEntityData":{"properties":{"aliases":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"facts":{"items":{"$ref":"#/components/schemas/SigmaidFact"},"nullable":true,"type":"array"},"locations":{"items":{"$ref":"#/components/schemas/SigmaidLocation"},"nullable":true,"type":"array"},"telephones":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"},"websites":{"items":{"$ref":"#/components/schemas/SigmaidTextWithSource"},"nullable":true,"type":"array"}},"type":"object"},"SigmaidLocation":{"properties":{"address":{"example":"10 Downing St, London SW1A 2AB, United Kingdom","type":"string"},"country":{"example":"United Kingdom","type":"string"},"countryCode":{"example":"GB","type":"string"},"fromDate":{"example":"1684-05-20","type":"string"},"locality":{"example":"London","type":"string"},"majorAdministrativeDivision":{"example":"England","type":"string"},"minorAdministrativeDivision":{"example":"City of Westminster","type":"string"},"postalCode":{"example":"SW1A 2AB","type":"string"},"sourceAttribution":{"description":"Not human readable. This can be used to look up against source information objects.","items":{"example":"abcd1234//1234567890","type":"string"},"nullable":true,"type":"array"},"streetName":{"example":"Downing St","type":"string"},"streetNumber":{"example":"10","type":"string"},"toDate":{"example":"2020-05-20","type":"string"},"type":{"example":"Residence","type":"string"}},"type":"object"},"SigmaidNetworkRiskProperties":{"properties":{"relationships":{"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"},"SigmaidNetworkRiskResult":{"properties":{"edges":{"description":"The relationships between the entities in the network. Each relationship connects two entities in the Nodes list.","items":{"$ref":"#/components/schemas/SigmaidEdge"},"nullable":true,"type":"array"},"nodes":{"description":"The individual entities that are part of the network of the requested entity.","items":{"$ref":"#/components/schemas/SigmaidNode"},"nullable":true,"type":"array"},"properties":{"$ref":"#/components/schemas/SigmaidNetworkRiskProperties"}},"type":"object"},"SigmaidNewsEvent":{"properties":{"articles":{"items":{"$ref":"#/components/schemas/SigmaidEventArticle"},"nullable":true,"type":"array"},"entityRisk":{"type":"string"},"eventConfidence":{"type":"number"},"eventLabel":{"type":"string"},"eventMaterialityScore":{"type":"number"},"eventSeverity":{"type":"string"},"humanVerified":{"type":"boolean"},"id":{"type":"string"},"isPreferredPublisher":{"type":"boolean"},"sigmaID":{"type":"string"},"topics":{"items":{"type":"string"},"nullable":true,"type":"array"},"unformattedLabel":{"type":"string"}},"type":"object"},"SigmaidNode":{"properties":{"entity":{"$ref":"#/components/schemas/SigmaidSummarySearchResultRow"},"entityType":{"description":"The type of the entity (e.g. person, company, vessel, aircraft).","type":"string"},"id":{"description":"The SigmaID of the entity represented by this node.","type":"string"},"isDisabled":{"description":"Whether the node is disabled due to filters or other factors. However, it may still be included because it is required to show a further node.","type":"boolean"},"name":{"description":"The SigmaID's canonical name.","type":"string"}},"type":"object"},"SigmaidPoliticalPosition":{"properties":{"country":{"type":"string"},"description":{"type":"string"},"from":{"nullable":true,"type":"string"},"sourceAttribution":{"description":"Not human readable. This can be used to look up against source information objects.","items":{"example":"abcd1234//1234567890","type":"string"},"nullable":true,"type":"array"},"to":{"nullable":true,"type":"string"}},"type":"object"},"SigmaidRelationshipChain":{"properties":{"edges":{"items":{"$ref":"#/components/schemas/SigmaidEdge"},"nullable":true,"type":"array"},"entities":{"items":{"$ref":"#/components/schemas/SigmaidBasicEntityResult"},"nullable":true,"type":"array"}},"type":"object"},"SigmaidRiskSummary":{"properties":{"score":{"type":"number"}},"type":"object"},"SigmaidSourceURL":{"properties":{"name":{"type":"string"},"url":{"nullable":true,"type":"string"}},"type":"object"},"SigmaidSourcesByIntegration":{"properties":{"key":{"type":"string"},"lastUpdated":{"format":"date-time","nullable":true,"type":"string"},"matches":{"items":{"type":"string"},"nullable":true,"type":"array"},"matchesOriginated":{"type":"integer"},"name":{"type":"string"},"ultimateSources":{"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"},"SigmaidSummarySearchResultRow":{"properties":{"aliases":{"items":{"example":"InGen, InGen Corp","type":"string"},"nullable":true,"type":"array"},"birthDates":{"description":"Birth dates of the entity","items":{"$ref":"#/components/schemas/SigmaidDateWithSource"},"nullable":true,"type":"array"},"entityName":{"example":"InGen Corporation","type":"string"},"entityType":{"example":"company","type":"string"},"foundationDates":{"description":"Foundation dates of the entity","items":{"$ref":"#/components/schemas/SigmaidDateWithSource"},"nullable":true,"type":"array"},"hasIndirectOwners":{"type":"boolean"},"hasNetworkConnections":{"type":"boolean"},"indicatorSummaries":{"items":{"$ref":"#/components/schemas/SigmaidIndicatorSummary"},"nullable":true,"type":"array"},"locations":{"items":{"$ref":"#/components/schemas/SigmaidLocation"},"nullable":true,"type":"array"},"matchDOB":{"type":"string"},"matchLocation":{"type":"string"},"matchName":{"type":"string"},"matchStrength":{"type":"number"},"risk":{"$ref":"#/components/schemas/SigmaidRiskSummary"},"sigmaID":{"example":"3BX869NCJTZ5K","type":"string"},"sources":{"items":{"$ref":"#/components/schemas/SigmaidSourcesByIntegration"},"nullable":true,"type":"array"}},"type":"object"},"SigmaidTextWithSource":{"properties":{"sourceAttribution":{"description":"Not human readable. This can be used to look up against source information objects.","items":{"example":"abcd1234//1234567890","type":"string"},"nullable":true,"type":"array"},"value":{"example":"\u003ctext\u003e","type":"string"}},"type":"object"}},"securitySchemes":{"apiKey":{"description":"API Key","in":"header","name":"Authorization","type":"apiKey"}}},"externalDocs":{"description":"Sigma360 Product Information","url":"https://sigma360.com"},"info":{"contact":{"email":"support@sigma360.com","name":"Sigma Customer Success Team"},"description":"### API Concepts\nThis API is designed to help you interact and integrate with Sigma360. You can use it to create new entities, receive notifications about changes to your entities, and retrieve information about your entities. All aspects of a Sigma360 entity can be retrieved through this API.\n\n#### Screening\nScreening identifies: risks, KYC details, news and other critical information based on the provided entity name. The results returned are determined by the pre-defined Filter Set (See below for more details).  \n\n##### Monitoring\nMonitoring will perform a continuous, ongoing screening function, where you can expect to receive alerts and updates about changes to your entities without needing to manually trigger a screening event.\nAn entity is under continuous monitoring if it appears in the 'Monitoring' tab and is not archived. Archiving an entity will suppress all alerts and updates for that entity.\n\n##### Alerts\nAlerts are discreet work items that bring a detected risk to an analyst's attention. You can find alerts in the UI's 'Alerts' tab. \nEvery monitored entity will create alerts as risks are detected. When you are performing a one-off screen, you can specify whether or not you want durable, UI-visible alerts to be created. Alerts created in this way will be visible together with alerts created through monitoring. \n\n\n#### Webhooks\nSeveral events will fire an out-of-band request back to your systems to inform you of data changes or allow you to take action.\n1. Entity Updated - changes to Matches, Indicators, KYC data or News\n2. Entity Creation Finished - a bulk entity creation job has completed\n\nNote that all Webhooks fire against a url provided by you during onboarding. If you need to change this url, please contact Sigma Customer Success.\n\n#### Filter Sets\nMonitoring and screening both use Filter Sets to configure returns and manage true and false positives according to organizational risk appetite.\nFor detailed information on ‘Filter Sets’ - contact Support: [support\\@sigmaratings.com](mailto:support\\@sigmaratings.com).\nScreening response data is organized by: Indicators, News and KYC details. \nFor more information on Indicators, News and KYC data see:[Sigma360 Indicators \u0026 Global Data](https://6879283.fs1.hubspotusercontent-na1.net/hubfs/6879283/02%20Product%20Documents/Sigma360%20Indicators%20\u0026%20Global%20Data.pdf). \n\n\n#### Conventions and Definitions\nAll entities are identified by a unique Sigma360 Entity ID (URN). These are stable over the entire lifetime of the entity.\n\nAll dates are expected in RFC3339 format or part thereof, e.g. \"2006-01-02T15:04:05Z07:00\".\n\nAll countries are expected to be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements), e.g. \"US\", or \"GB\".\nIn general, when a filter is not specified, the default is to return all entities for that field.\n\n##### Rate Limiting\nBy default, we impose a maximum of 100 requests per second per account. If you exceed this limit, you will receive a 429 response codes for the extra requests.\nWe encourage you to aggressively retry requests that were rate-limited, as these do not count against the limit. The limits \ndo not carry over and do not have any memory of previous rate limit events. If you are consistently hitting rate limits, please contact Sigma Customer Success.\n\n##### UI Only tasks\nCertain administrative tasks are limited to the UI and are not available via API. These are:\n1. Creation and maintenance of Filter Sets\n2. Changing the group of one or more entities\n3. Changing the Filter Set for one ore more entities\n4. Review workflow\n","title":"Sigma360 API","version":"v2.0.1","x-logo":{"altText":"Sigma360","href":"https://sigma360.com","url":"logo.png"}},"openapi":"3.1.0","paths":{"/account/status":{"get":{"description":"This endpoint is used to check the organization-wide metadata for your Sigma360 account.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthResponsesAccountStatus"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Retrieve account status","tags":["Account"]}},"/alerts":{"post":{"description":"This endpoint retrieves the alerts listing. By default, it will return open alerts. An alert is a list of new risks seen since the last alert was closed. You can paginate with a cursor using the 'id' column.","parameters":[{"description":"The field name that you want to sort by. Many fields in the response are sortable, but not all.","in":"query","name":"sortBy","schema":{"description":"The field name that you want to sort by. Many fields in the response are sortable, but not all.","nullable":true,"type":"string"}},{"description":"ASC or DESC. Defaults: DESC","in":"query","name":"sortOrder","schema":{"description":"ASC or DESC. Defaults: DESC","example":"asc","nullable":true,"type":"string"}},{"description":"Page number, 1-indexed. Default: 1","in":"query","name":"page","schema":{"description":"Page number, 1-indexed. Default: 1","example":1,"type":"integer"}},{"description":"Number of results per page. Maximum: 100, Default: 10","in":"query","name":"pageSize","schema":{"description":"Number of results per page. Maximum: 100, Default: 10","example":10,"type":"integer"}},{"in":"query","name":"cursor","schema":{"nullable":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestAlertsListingRequestPubliclyDocumented"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseAlertSummary"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Retrieve a listing of Alerts","tags":["Monitoring: Entity Management"]}},"/entities":{"post":{"description":"Use this endpoint to browse your monitored entity population. It is filterable and shows all of your entities at a glance.","parameters":[{"description":"The field name that you want to sort by. Many fields in the response are sortable, but not all.","in":"query","name":"sortBy","schema":{"description":"The field name that you want to sort by. Many fields in the response are sortable, but not all.","nullable":true,"type":"string"}},{"description":"ASC or DESC. Defaults: DESC","in":"query","name":"sortOrder","schema":{"description":"ASC or DESC. Defaults: DESC","example":"asc","nullable":true,"type":"string"}},{"description":"Page number, 1-indexed. Default: 1","in":"query","name":"page","schema":{"description":"Page number, 1-indexed. Default: 1","example":1,"type":"integer"}},{"description":"Number of results per page. Maximum: 100, Default: 10","in":"query","name":"pageSize","schema":{"description":"Number of results per page. Maximum: 100, Default: 10","example":10,"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestEntitiesRequestPublic"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePaginatedEntitySummaries"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Retrieve a paginated list of entity summaries","tags":["Monitoring: Entity Management"]}},"/entities/archive":{"put":{"description":"This endpoint will archive one or more entities. Archived entities will no longer be monitored and will not appear in your Monitoring population.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestArchiveEntityRequestPublic"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseStatus"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Archive one or more entities","tags":["Monitoring: Entity Management"]}},"/entities/by-task-id/current-state/{taskID}":{"get":{"description":"This endpoint retrieves a paginated list of entities created by a bulk entity creation task. If the enqueued task is not yet finished, this endpoint will return an HTTP 425 Too Early response. The response format is not in the typical summary format, but instead, it is the full format typically available from the \"Retrieve an Entity's current state\" endpoint.","parameters":[{"description":"Page number, 1-indexed. Default: 1","in":"query","name":"page","schema":{"description":"Page number, 1-indexed. Default: 1","example":1,"type":"integer"}},{"description":"Number of results per page. Maximum: 100, Default: 10","in":"query","name":"pageSize","schema":{"description":"Number of results per page. Maximum: 100, Default: 10","example":10,"type":"integer"}},{"description":"The task ID returned from the upload request","in":"path","name":"taskID","required":true,"schema":{"description":"The task ID returned from the upload request","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePaginatedFullEntities"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"425":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Early"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Retrieve the entities created by a bulk entity creation task","tags":["Monitoring: Entity Management"]}},"/entities/create":{"post":{"description":"This endpoint will synchronously add one entity to your monitored entity population. This returns the full state of the entity, for convenience. If you are adding more than one entity, it is recommend that you use the bulk endpoint for performance.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestSingleEntityUploadRequestPublic"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntity"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Create one Entity","tags":["Monitoring: Entity Creation"]}},"/entities/create/assume-clean":{"post":{"description":"For system migrations only. This endpoint will asynchronously add one or more entities to your monitored entity population, skipping alerts, ignoring existing risk, and force-setting the status as cleared.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestEntitiesUploadRequestPublic"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBulkEntityUploadResponse"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Migrate Pre-reviewed Entities into Sigma360 (Skip Risk and Alerts)","tags":["Monitoring: Entity Creation"]}},"/entities/create/enqueue":{"post":{"description":"This endpoint will asynchronously add one or more entities to your monitored entity population. It is recommended that you use this endpoint when adding more than one entity. You will receive a webhook event when the entity creation job completes.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestEntitiesUploadRequestPublic"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBulkEntityUploadResponse"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Enqueue a bulk entity creation task","tags":["Monitoring: Entity Creation"]}},"/entities/create/status/{taskID}":{"get":{"description":"This endpoint reports the progress of bulk entity creation tasks. If registered, you will receive a webhook event when the entity creation job completes.","parameters":[{"description":"Page number, 1-indexed. Default: 1","in":"query","name":"page","schema":{"description":"Page number, 1-indexed. Default: 1","example":1,"type":"integer"}},{"description":"Number of results per page. Maximum: 100, Default: 10","in":"query","name":"pageSize","schema":{"description":"Number of results per page. Maximum: 100, Default: 10","example":10,"type":"integer"}},{"description":"The task ID returned from the upload request","in":"path","name":"taskID","required":true,"schema":{"description":"The task ID returned from the upload request","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseTaskProgress"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Check on the progress or errors of a bulk entity creation task","tags":["Monitoring: Entity Creation"]}},"/entities/histories":{"post":{"description":"This endpoint will return a paginated list of all entities' history events. A history event is created whenever an entity's data changes for any reason. Only includes monitored, unarchived entities.","parameters":[{"description":"Page number, 1-indexed. Default: 1","in":"query","name":"page","schema":{"description":"Page number, 1-indexed. Default: 1","example":1,"type":"integer"}},{"description":"Number of results per page. Maximum: 100, Default: 10","in":"query","name":"pageSize","schema":{"description":"Number of results per page. Maximum: 100, Default: 10","example":10,"type":"integer"}},{"in":"query","name":"cursor","schema":{"nullable":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestEntitiesHistoriesRequestPublic"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePaginatedEntityHistory"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Retrieve history events for all entities in a paginated stream","tags":["Monitoring: History"]}},"/entity/{entityURN}":{"get":{"description":"This endpoint includes a single entity's latest indicators, matches, and profile information.","parameters":[{"description":"The entity ID or URN.","in":"path","name":"entityURN","required":true,"schema":{"description":"The entity ID or URN.","example":"urn:sigma:entity:1234-abcdef","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntity"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Retrieve an entity's current state","tags":["Monitoring: Entity Management"]}},"/entity/{entityURN}/history":{"post":{"description":"This endpoint will return a paginated list of entity history events for a given entity. A history event is created whenever an entity's data changes for any reason.","parameters":[{"description":"Page number, 1-indexed. Default: 1","in":"query","name":"page","schema":{"description":"Page number, 1-indexed. Default: 1","example":1,"type":"integer"}},{"description":"Number of results per page. Maximum: 100, Default: 10","in":"query","name":"pageSize","schema":{"description":"Number of results per page. Maximum: 100, Default: 10","example":10,"type":"integer"}},{"description":"The entity ID or URN.","in":"path","name":"entityURN","required":true,"schema":{"description":"The entity ID or URN.","example":"urn:sigma:entity:1234-abcdef","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestEntityHistoryRequestPublic"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePaginatedEntityHistory"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Retrieve a paginated list of entity history events","tags":["Monitoring: History"]}},"/entity/{entityURN}/news":{"post":{"description":"This endpoint will return a paginated list of machine-curated Sigma News events for a given entity.","parameters":[{"description":"Page number, 1-indexed. Default: 1","in":"query","name":"page","schema":{"description":"Page number, 1-indexed. Default: 1","example":1,"type":"integer"}},{"description":"Number of results per page. Maximum: 100, Default: 10","in":"query","name":"pageSize","schema":{"description":"Number of results per page. Maximum: 100, Default: 10","example":10,"type":"integer"}},{"description":"The field name that you want to sort by. Many fields in the response are sortable, but not all.","in":"query","name":"sortBy","schema":{"description":"The field name that you want to sort by. Many fields in the response are sortable, but not all.","nullable":true,"type":"string"}},{"description":"ASC or DESC. Defaults: DESC","in":"query","name":"sortOrder","schema":{"description":"ASC or DESC. Defaults: DESC","example":"asc","nullable":true,"type":"string"}},{"description":"The entity ID or URN.","in":"path","name":"entityURN","required":true,"schema":{"description":"The entity ID or URN.","example":"urn:sigma:entity:1234-abcdef","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestEntityNewsRequestPublic"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseNews"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Retrieve Sigma News Events for a given entity","tags":["Monitoring: Entity Management"]}},"/entity/{entityURN}/profile-by-matches":{"post":{"description":"This endpoint returns profile information (KYC and Facets), but match-by-match. This allows you to correlate profile information to matches.","parameters":[{"description":"The entity ID or URN.","in":"path","name":"entityURN","required":true,"schema":{"description":"The entity ID or URN.","example":"urn:sigma:entity:1234-abcdef","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestMatchesSummaryRequestPublic"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseProfileInformationByMatch"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Retrieve a profile information, divided by match","tags":["Monitoring: Entity Management"]}},"/group":{"post":{"description":"Create a single entity group under your account.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestCreateEntityGroupRequestPublic"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityGroup"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Create a single entity group","tags":["Monitoring: Entity Creation"]}},"/groups":{"get":{"description":"Returns all entity groups created under your account.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityGroups"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Retrieve all entity groups","tags":["Monitoring: Entity Creation"]}},"/info/sources":{"get":{"description":"This endpoint will return a list of all generally-available sources in the Sigma platform, and the last time they were updated. ReportDataSources matches what is available in the UI, under the 'Reports' tab.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SigmaidDataSourcesResponse"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Get update times for all sources","tags":["Informational"]}},"/news/event/{uuid}/article/{hash}":{"get":{"description":"This endpoint retrieves the full body of a news article referenced in a Sigma News Event. For licensing and performance reasons, this must be called only as a response to user action, and not in bulk. The response includes highlights of relevant phrases, entities, and locations in the article.","parameters":[{"description":"The individual article. Each article is uniquely identified by its hash.","in":"path","name":"hash","required":true,"schema":{"description":"The individual article. Each article is uniquely identified by its hash.","type":"string"}},{"description":"The event UUID that includes the article. In the entity news endpoint, this is called the event's ID","in":"path","name":"uuid","required":true,"schema":{"description":"The event UUID that includes the article. In the entity news endpoint, this is called the event's ID","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SigmaidEventArticle"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Retrieve the full body of a referenced news article","tags":["Monitoring: Entity Management"]}},"/screening/full-single":{"post":{"description":"This endpoint is used to perform a screen of a single entity. It is done synchronously and returns a summary of the results. You must specify a filter set, which will be used for this search. The fields, coverage, and match threshold are determined by the filterset.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestFullSingleScreeningRequestPublic"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseFullSearchResultWithAlertPubliclyDocumented"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Real-time Single Screening","tags":["One-Off Screening"]}},"/utils/send-webhook-test\"":{"get":{"description":"This endpoint causes a webhook message to be delivered to your configured webhook target. It will be delivered from the same network and with the same options as real webhooks. This operation is asynchronous; it will return a 200 when it queues the test event, even if the webhook then fails or if no webhook is configured on your account. Tests will not be retried.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseWebhookTestEndpointResponse"}}},"description":"OK"},"400":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Bad Request"},"401":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Unauthorized"},"429":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Too Many Requests"},"500":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Internal Server Error"}},"security":[{"apiKey":[]}],"summary":"Perform a test delivery of your webhook connection","tags":["Utilities"]}}},"security":[{"apiKey":[]}],"servers":[{"url":"https://api.sigma360.com/external/v2"}],"tags":[{"description":"Account management","name":"Account"},{"description":"Screening against Sigma360's risk data","name":"One-Off Screening"},{"description":"Creating new 'My Entities'","name":"Monitoring: Entity Creation"},{"description":"Browsing and retrieving monitored entities","name":"Monitoring: Entity Management"},{"description":"Retrieving monitoring history","name":"Monitoring: History"},{"description":"General utilities","name":"Utilities"},{"description":"Informational endpoints","name":"Informational"},{"description":"Webhooks that notify you of important events","name":"Webhooks"}],"webhooks":{"Entity Created":{"post":{"tags":["Webhooks"],"summary":"Fires when an Entity Creation Job completes","description":"After using the enqueue bulk entity creation endpoint through the API, or after a user begins an Entity creation job in the Sigma360 interface, this webhook will be triggered when the job completes. Entity creation jobs are atomic. If any entities could not be created, none of the entities are created. The response contains a list of entities that failed during creation, if any were present. If success is false, no entities were created.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseTaskCompletionReportPing"}}}},"responses":{},"security":[{"apiKey":[]}]}},"Entity Disposition Changed":{"post":{"tags":["Webhooks"],"summary":"Fires when a Monitored Entity's disposition is changed by a user","description":"When a user changes the disposition of a monitored entity, this webhook will be triggered. Dispositions are the user's determinations to the final state of an entity, such as 'Cleared' or 'Blocked'.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityDispositionChangePing"}}}},"responses":{},"security":[{"apiKey":[]}]}},"History Updated":{"post":{"tags":["Webhooks"],"summary":"Fires when a Monitored Entity updates","description":"When a monitored entity has a data update for any reason, this webhook will be triggered. History updates may describe decisions, reviews, or updates from underlying data sources or statistical models.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseEntityHistoryPing"}}}},"responses":{},"security":[{"apiKey":[]}]}},"New Case Management Entry":{"post":{"tags":["Webhooks"],"summary":"Fires when a user sends an entity to an external case management system","description":"In some configurations, users can send entities to an external case management system for review and action. When this occurs, this webhook will be triggered, allowing you to synchronize your case management system with Sigma360.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCaseManagementIntentPing"}}}},"responses":{},"security":[{"apiKey":[]}]}}}}