---
title: "Create one Entity"
method: POST
path: "/entities/create"
tags: ["Monitoring: Entity Creation"]
---

# Create one Entity

`POST /entities/create`

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.

## Request body

- RequestSingleEntityUploadRequestPublic
  - `entityGroupIDs` integer[], nullable, required
  - `filterSetID` integer, required
  - `search` SigmaidBasicSearchParams
    - `aliases` string[], nullable — Secondary names to perform a search on
    - `countries` string[], nullable — ISO 3166-1 alpha-2
    - `customFields` SigmaidCustomEntityField[], nullable — 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.
      - `key` string
      - `value` string
    - `customerKey` string — Optional. A user-provided identifier that will be returned in alerts and monitoring. Any format.
    - `dob` string, nullable — Birth or foundation date. YYYY, YYYY-MM, YYYY-MM-DD, YYYY/MM or YYYY/MM/DD format.
    - `entityName` string, required — The primary name of the search
    - `entityType` 'person' | 'company' | 'aircraft' | 'vessel', nullable

## Response `200`

OK

- ResponseEntity
  - `archivedAt` string, date-time, nullable — Not null if the entity has been archived. The time when the entity was archived
  - `createdAt` string, date-time
  - `customFields` SigmaidCustomEntityField[], nullable — User-provided metadata, any format. Does not affect matching, risk, or profile data.
    - `key` string
    - `value` string
  - `customerKey` string — Optional. A user-provided identifier that will be returned in alerts and monitoring. Any format.
  - `dispositionState` ResponseEntityDispositionState
    - `dispositionSetAtTime` string, date-time, nullable — The time when the disposition was last set
    - `dispositionSetByUserName` string, nullable — The name of the user who last set the disposition
    - `dispositionSetByUserURN` string, nullable — The URN of the user who last set the disposition
    - `dispositionState` string — The current disposition state of the entity. Should be unsnaked and titlecased before UI display
  - `entityGroups` ResponseMinimalEntityGroup[], nullable
    - `entityGroupName` string
    - `id` integer
  - `entityName` string
  - `entitySources` CommonEntitySource[], nullable — Describes which job or action created the entity
    - `sourceID` string — The ID of the process run that created the entity
    - `sourceType` string — Which kind of process created or referenced the entity
  - `entityType` 'company' | 'person' | 'vessel' | 'aircraft' | '', nullable — The resolved entity type
  - `escalated` boolean
  - `escalatedByUserName` string, nullable
  - `escalatedByUserUrn` string, nullable
  - `escalatedTime` string, date-time, nullable
  - `filterSetID` integer
  - `filterSetName` string
  - `hasOpenAlert` boolean — Whether the entity has an open alert
  - `indicatorSummaries` SigmaidIndicatorSummary[], nullable — The summary of the indicators that are currently active
    - `category` string
    - `count` integer
    - `isNetwork` boolean — Indicates whether the indicator is describes this entity or one of its network connections
    - `maxScore` integer
  - `indicators` ResponseIndicators
    - `acceptedRisks` ResponseIndicator[], nullable — The risk indicators that have been accepted by a user in your organization. These are not considered for risk score calculation.
      - `category` string, required
      - `causalSigmaID` SigmaidSummarySearchResultRow
        - `aliases` string[], nullable
        - `birthDates` SigmaidDateWithSource[], nullable — Birth dates of the entity
          - `humanReadable` string, nullable — A human-readable representation of the range. Show in user interfaces instead of the date range if present
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `until` string, date-time, nullable — If the date is a range, the end of the range
          - `value` string, date-time — The date, or the start of a date range
        - `entityName` string
        - `entityType` string
        - `foundationDates` SigmaidDateWithSource[], nullable — Foundation dates of the entity
          - `humanReadable` string, nullable — A human-readable representation of the range. Show in user interfaces instead of the date range if present
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `until` string, date-time, nullable — If the date is a range, the end of the range
          - `value` string, date-time — The date, or the start of a date range
        - `hasIndirectOwners` boolean
        - `hasNetworkConnections` boolean
        - `indicatorSummaries` SigmaidIndicatorSummary[], nullable
          - `category` string
          - `count` integer
          - `isNetwork` boolean — Indicates whether the indicator is describes this entity or one of its network connections
          - `maxScore` integer
        - `locations` SigmaidLocation[], nullable
          - `address` string
          - `country` string
          - `countryCode` string
          - `fromDate` string
          - `locality` string
          - `majorAdministrativeDivision` string
          - `minorAdministrativeDivision` string
          - `postalCode` string
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `streetName` string
          - `streetNumber` string
          - `toDate` string
          - `type` string
        - `matchDOB` string
        - `matchLocation` string
        - `matchName` string
        - `matchStrength` number
        - `risk` SigmaidRiskSummary
          - `score` number
        - `sigmaID` string
        - `sources` SigmaidSourcesByIntegration[], nullable
          - `key` string
          - `lastUpdated` string, date-time, nullable
          - `matches` string[], nullable
          - `matchesOriginated` integer
          - `name` string
          - `ultimateSources` string[], nullable
      - `code` string, required
      - `date` string, date-time, nullable
      - `decisioning` ResponseDecisionState
        - `decidedByDefault` boolean
        - `decisionedAgainst` boolean
        - `hasDecision` boolean
        - `notes` string
        - `rationale` string[], nullable
        - `reviewSubmittedAt` string
        - `reviewedByUserName` string
        - `reviewedByUserURN` string
        - `wasDecisionMadeAgainstThisVersion` boolean
      - `decisioningTimeline` ResponseDecisionTimelineState[], nullable
        - `decidedByDefault` boolean
        - `decisionedAgainst` boolean
        - `notes` string
        - `rationale` string[], nullable
        - `reviewSubmittedAt` string
        - `reviewedByUserName` string
        - `reviewedByUserURN` string
      - `description` string, required
      - `extras` object, nullable — Extra details about the indicator
      - `hopsAway` integer, required
      - `name` string, required
      - `originatingSigmaID` string
      - `primaryExtras` object, nullable — Extra details about the indicator, typical shown above the fold
      - `relationshipChain` SigmaidRelationshipChain
        - `edges` SigmaidEdge[], nullable
          - `edgeID` string — A unique identifier for this edge.
          - `extendedRelationshipData` SigmaidExtendedRelationshipData
            - `asOfDate` string — The date this relationship data was reported as of.
            - `currency` string — The currency of the monetary value.
            - `endDate` string — The date this relationship ended.
            - `former` boolean — Whether this relationship is no longer active.
            - `monetaryValue` string — The monetary value associated with this relationship.
            - `numShares` string — The number of shares held in this relationship.
            - `percent` string — The ownership or control percentage associated with this relationship.
            - `startDate` string — The date this relationship began.
            - `ultimateSources` string[], nullable — The original data sources for this relationship.
          - `fromNode` string — The SigmaID of the node that this edge starts from.
          - `inverseRelationship` string — The normalized relationship in the inverse direction.
          - `relationship` string — The normalized relationship, as determined by SigmaID's NLP models.
          - `relationshipDenotesOwnership` boolean — 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.
          - `toNode` string — The SigmaID of the node that this edge points to.
          - `unnormalizedRelationship` string — The raw text of the relationship as it appears in the source data.
        - `entities` SigmaidBasicEntityResult[], nullable
          - `entityName` string
          - `entityType` string
          - `sigmaID` string
      - `score` integer
      - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
      - `sources` SigmaidSourceURL[], nullable, required
        - `name` string
        - `url` string, nullable
      - `subcategory` string, required
      - `urn` string, required
    - `activeRisks` ResponseIndicator[], nullable — The active risk indicators that are currently influencing the entity risk score.
      - `category` string, required
      - `causalSigmaID` SigmaidSummarySearchResultRow
        - `aliases` string[], nullable
        - `birthDates` SigmaidDateWithSource[], nullable — Birth dates of the entity
          - `humanReadable` string, nullable — A human-readable representation of the range. Show in user interfaces instead of the date range if present
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `until` string, date-time, nullable — If the date is a range, the end of the range
          - `value` string, date-time — The date, or the start of a date range
        - `entityName` string
        - `entityType` string
        - `foundationDates` SigmaidDateWithSource[], nullable — Foundation dates of the entity
          - `humanReadable` string, nullable — A human-readable representation of the range. Show in user interfaces instead of the date range if present
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `until` string, date-time, nullable — If the date is a range, the end of the range
          - `value` string, date-time — The date, or the start of a date range
        - `hasIndirectOwners` boolean
        - `hasNetworkConnections` boolean
        - `indicatorSummaries` SigmaidIndicatorSummary[], nullable
          - `category` string
          - `count` integer
          - `isNetwork` boolean — Indicates whether the indicator is describes this entity or one of its network connections
          - `maxScore` integer
        - `locations` SigmaidLocation[], nullable
          - `address` string
          - `country` string
          - `countryCode` string
          - `fromDate` string
          - `locality` string
          - `majorAdministrativeDivision` string
          - `minorAdministrativeDivision` string
          - `postalCode` string
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `streetName` string
          - `streetNumber` string
          - `toDate` string
          - `type` string
        - `matchDOB` string
        - `matchLocation` string
        - `matchName` string
        - `matchStrength` number
        - `risk` SigmaidRiskSummary
          - `score` number
        - `sigmaID` string
        - `sources` SigmaidSourcesByIntegration[], nullable
          - `key` string
          - `lastUpdated` string, date-time, nullable
          - `matches` string[], nullable
          - `matchesOriginated` integer
          - `name` string
          - `ultimateSources` string[], nullable
      - `code` string, required
      - `date` string, date-time, nullable
      - `decisioning` ResponseDecisionState
        - `decidedByDefault` boolean
        - `decisionedAgainst` boolean
        - `hasDecision` boolean
        - `notes` string
        - `rationale` string[], nullable
        - `reviewSubmittedAt` string
        - `reviewedByUserName` string
        - `reviewedByUserURN` string
        - `wasDecisionMadeAgainstThisVersion` boolean
      - `decisioningTimeline` ResponseDecisionTimelineState[], nullable
        - `decidedByDefault` boolean
        - `decisionedAgainst` boolean
        - `notes` string
        - `rationale` string[], nullable
        - `reviewSubmittedAt` string
        - `reviewedByUserName` string
        - `reviewedByUserURN` string
      - `description` string, required
      - `extras` object, nullable — Extra details about the indicator
      - `hopsAway` integer, required
      - `name` string, required
      - `originatingSigmaID` string
      - `primaryExtras` object, nullable — Extra details about the indicator, typical shown above the fold
      - `relationshipChain` SigmaidRelationshipChain
        - `edges` SigmaidEdge[], nullable
          - `edgeID` string — A unique identifier for this edge.
          - `extendedRelationshipData` SigmaidExtendedRelationshipData
            - `asOfDate` string — The date this relationship data was reported as of.
            - `currency` string — The currency of the monetary value.
            - `endDate` string — The date this relationship ended.
            - `former` boolean — Whether this relationship is no longer active.
            - `monetaryValue` string — The monetary value associated with this relationship.
            - `numShares` string — The number of shares held in this relationship.
            - `percent` string — The ownership or control percentage associated with this relationship.
            - `startDate` string — The date this relationship began.
            - `ultimateSources` string[], nullable — The original data sources for this relationship.
          - `fromNode` string — The SigmaID of the node that this edge starts from.
          - `inverseRelationship` string — The normalized relationship in the inverse direction.
          - `relationship` string — The normalized relationship, as determined by SigmaID's NLP models.
          - `relationshipDenotesOwnership` boolean — 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.
          - `toNode` string — The SigmaID of the node that this edge points to.
          - `unnormalizedRelationship` string — The raw text of the relationship as it appears in the source data.
        - `entities` SigmaidBasicEntityResult[], nullable
          - `entityName` string
          - `entityType` string
          - `sigmaID` string
      - `score` integer
      - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
      - `sources` SigmaidSourceURL[], nullable, required
        - `name` string
        - `url` string, nullable
      - `subcategory` string, required
      - `urn` string, required
    - `risksRequiringReview` ResponseIndicator[] — Used only for user-review-enabled clients. Indicators that have been escalated for review, but have not yet been reviewed.
      - `category` string, required
      - `causalSigmaID` SigmaidSummarySearchResultRow
        - `aliases` string[], nullable
        - `birthDates` SigmaidDateWithSource[], nullable — Birth dates of the entity
          - `humanReadable` string, nullable — A human-readable representation of the range. Show in user interfaces instead of the date range if present
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `until` string, date-time, nullable — If the date is a range, the end of the range
          - `value` string, date-time — The date, or the start of a date range
        - `entityName` string
        - `entityType` string
        - `foundationDates` SigmaidDateWithSource[], nullable — Foundation dates of the entity
          - `humanReadable` string, nullable — A human-readable representation of the range. Show in user interfaces instead of the date range if present
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `until` string, date-time, nullable — If the date is a range, the end of the range
          - `value` string, date-time — The date, or the start of a date range
        - `hasIndirectOwners` boolean
        - `hasNetworkConnections` boolean
        - `indicatorSummaries` SigmaidIndicatorSummary[], nullable
          - `category` string
          - `count` integer
          - `isNetwork` boolean — Indicates whether the indicator is describes this entity or one of its network connections
          - `maxScore` integer
        - `locations` SigmaidLocation[], nullable
          - `address` string
          - `country` string
          - `countryCode` string
          - `fromDate` string
          - `locality` string
          - `majorAdministrativeDivision` string
          - `minorAdministrativeDivision` string
          - `postalCode` string
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `streetName` string
          - `streetNumber` string
          - `toDate` string
          - `type` string
        - `matchDOB` string
        - `matchLocation` string
        - `matchName` string
        - `matchStrength` number
        - `risk` SigmaidRiskSummary
          - `score` number
        - `sigmaID` string
        - `sources` SigmaidSourcesByIntegration[], nullable
          - `key` string
          - `lastUpdated` string, date-time, nullable
          - `matches` string[], nullable
          - `matchesOriginated` integer
          - `name` string
          - `ultimateSources` string[], nullable
      - `code` string, required
      - `date` string, date-time, nullable
      - `decisioning` ResponseDecisionState
        - `decidedByDefault` boolean
        - `decisionedAgainst` boolean
        - `hasDecision` boolean
        - `notes` string
        - `rationale` string[], nullable
        - `reviewSubmittedAt` string
        - `reviewedByUserName` string
        - `reviewedByUserURN` string
        - `wasDecisionMadeAgainstThisVersion` boolean
      - `decisioningTimeline` ResponseDecisionTimelineState[], nullable
        - `decidedByDefault` boolean
        - `decisionedAgainst` boolean
        - `notes` string
        - `rationale` string[], nullable
        - `reviewSubmittedAt` string
        - `reviewedByUserName` string
        - `reviewedByUserURN` string
      - `description` string, required
      - `extras` object, nullable — Extra details about the indicator
      - `hopsAway` integer, required
      - `name` string, required
      - `originatingSigmaID` string
      - `primaryExtras` object, nullable — Extra details about the indicator, typical shown above the fold
      - `relationshipChain` SigmaidRelationshipChain
        - `edges` SigmaidEdge[], nullable
          - `edgeID` string — A unique identifier for this edge.
          - `extendedRelationshipData` SigmaidExtendedRelationshipData
            - `asOfDate` string — The date this relationship data was reported as of.
            - `currency` string — The currency of the monetary value.
            - `endDate` string — The date this relationship ended.
            - `former` boolean — Whether this relationship is no longer active.
            - `monetaryValue` string — The monetary value associated with this relationship.
            - `numShares` string — The number of shares held in this relationship.
            - `percent` string — The ownership or control percentage associated with this relationship.
            - `startDate` string — The date this relationship began.
            - `ultimateSources` string[], nullable — The original data sources for this relationship.
          - `fromNode` string — The SigmaID of the node that this edge starts from.
          - `inverseRelationship` string — The normalized relationship in the inverse direction.
          - `relationship` string — The normalized relationship, as determined by SigmaID's NLP models.
          - `relationshipDenotesOwnership` boolean — 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.
          - `toNode` string — The SigmaID of the node that this edge points to.
          - `unnormalizedRelationship` string — The raw text of the relationship as it appears in the source data.
        - `entities` SigmaidBasicEntityResult[], nullable
          - `entityName` string
          - `entityType` string
          - `sigmaID` string
      - `score` integer
      - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
      - `sources` SigmaidSourceURL[], nullable, required
        - `name` string
        - `url` string, nullable
      - `subcategory` string, required
      - `urn` string, required
  - `matches` ResponseMatches
    - `matchesRequiringReview` ResponseMatch[] — Used only for user-review-enabled clients. Matches that have been escalated for review, but have not yet been reviewed.
      - `aliases` string[], nullable
      - `birthDates` SigmaidDateWithSource[], nullable — Birth dates of the entity
        - `humanReadable` string, nullable — A human-readable representation of the range. Show in user interfaces instead of the date range if present
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `until` string, date-time, nullable — If the date is a range, the end of the range
        - `value` string, date-time — The date, or the start of a date range
      - `decisioning` ResponseDecisionState
        - `decidedByDefault` boolean
        - `decisionedAgainst` boolean
        - `hasDecision` boolean
        - `notes` string
        - `rationale` string[], nullable
        - `reviewSubmittedAt` string
        - `reviewedByUserName` string
        - `reviewedByUserURN` string
        - `wasDecisionMadeAgainstThisVersion` boolean
      - `decisioningTimeline` ResponseDecisionTimelineState[], nullable
        - `decidedByDefault` boolean
        - `decisionedAgainst` boolean
        - `notes` string
        - `rationale` string[], nullable
        - `reviewSubmittedAt` string
        - `reviewedByUserName` string
        - `reviewedByUserURN` string
      - `entityName` string
      - `entityType` string, nullable
      - `foundationDates` SigmaidDateWithSource[], nullable — Foundation dates of the entity
        - `humanReadable` string, nullable — A human-readable representation of the range. Show in user interfaces instead of the date range if present
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `until` string, date-time, nullable — If the date is a range, the end of the range
        - `value` string, date-time — The date, or the start of a date range
      - `genders` SigmaidTextWithSource[], nullable — Listed genders of the entity
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `value` string
      - `identifiers` SigmaidIdentification[], nullable — Identification numbers of the entity
        - `country` string, nullable
        - `extras` object, nullable
        - `label` string
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `value` string
      - `indicatorSummaries` SigmaidIndicatorSummary[], nullable
        - `category` string
        - `count` integer
        - `isNetwork` boolean — Indicates whether the indicator is describes this entity or one of its network connections
        - `maxScore` integer
      - `locations` SigmaidLocation[], nullable
        - `address` string
        - `country` string
        - `countryCode` string
        - `fromDate` string
        - `locality` string
        - `majorAdministrativeDivision` string
        - `minorAdministrativeDivision` string
        - `postalCode` string
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `streetName` string
        - `streetNumber` string
        - `toDate` string
        - `type` string
      - `matchDOB` string — The match date from your search date of birth and date of birth proximity
      - `matchLocation` string — The match location from your search countries and location proximity
      - `matchName` string — The alias or name that was most similar to your search term
      - `matchStrength` number — The match strength of the matchName to your search term
      - `riskMetadata` ResponseRiskMetadata
        - `newsMetadata` ResponseNewsMetadata[], nullable — The news events that are currently detected
          - `count` integer — The number of news events for this type that are currently detected
          - `eventNewsType` string — The event news type currently detected
          - `samplePublishers` string[], nullable — A sample of the publishers that are currently detected
          - `unformattedEventNewsType` string — The unformatted event news type currently detected
        - `pepLevels` string[], nullable — The PEP levels that are currently detected
        - `sanctionLists` string[], nullable — The sanction lists that are currently detected
      - `riskScore` number
      - `sigmaID` string
    - `negativelyDecisionedMatches` ResponseMatch[], nullable — 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.
      - `aliases` string[], nullable
      - `birthDates` SigmaidDateWithSource[], nullable — Birth dates of the entity
        - `humanReadable` string, nullable — A human-readable representation of the range. Show in user interfaces instead of the date range if present
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `until` string, date-time, nullable — If the date is a range, the end of the range
        - `value` string, date-time — The date, or the start of a date range
      - `decisioning` ResponseDecisionState
        - `decidedByDefault` boolean
        - `decisionedAgainst` boolean
        - `hasDecision` boolean
        - `notes` string
        - `rationale` string[], nullable
        - `reviewSubmittedAt` string
        - `reviewedByUserName` string
        - `reviewedByUserURN` string
        - `wasDecisionMadeAgainstThisVersion` boolean
      - `decisioningTimeline` ResponseDecisionTimelineState[], nullable
        - `decidedByDefault` boolean
        - `decisionedAgainst` boolean
        - `notes` string
        - `rationale` string[], nullable
        - `reviewSubmittedAt` string
        - `reviewedByUserName` string
        - `reviewedByUserURN` string
      - `entityName` string
      - `entityType` string, nullable
      - `foundationDates` SigmaidDateWithSource[], nullable — Foundation dates of the entity
        - `humanReadable` string, nullable — A human-readable representation of the range. Show in user interfaces instead of the date range if present
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `until` string, date-time, nullable — If the date is a range, the end of the range
        - `value` string, date-time — The date, or the start of a date range
      - `genders` SigmaidTextWithSource[], nullable — Listed genders of the entity
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `value` string
      - `identifiers` SigmaidIdentification[], nullable — Identification numbers of the entity
        - `country` string, nullable
        - `extras` object, nullable
        - `label` string
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `value` string
      - `indicatorSummaries` SigmaidIndicatorSummary[], nullable
        - `category` string
        - `count` integer
        - `isNetwork` boolean — Indicates whether the indicator is describes this entity or one of its network connections
        - `maxScore` integer
      - `locations` SigmaidLocation[], nullable
        - `address` string
        - `country` string
        - `countryCode` string
        - `fromDate` string
        - `locality` string
        - `majorAdministrativeDivision` string
        - `minorAdministrativeDivision` string
        - `postalCode` string
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `streetName` string
        - `streetNumber` string
        - `toDate` string
        - `type` string
      - `matchDOB` string — The match date from your search date of birth and date of birth proximity
      - `matchLocation` string — The match location from your search countries and location proximity
      - `matchName` string — The alias or name that was most similar to your search term
      - `matchStrength` number — The match strength of the matchName to your search term
      - `riskMetadata` ResponseRiskMetadata
        - `newsMetadata` ResponseNewsMetadata[], nullable — The news events that are currently detected
          - `count` integer — The number of news events for this type that are currently detected
          - `eventNewsType` string — The event news type currently detected
          - `samplePublishers` string[], nullable — A sample of the publishers that are currently detected
          - `unformattedEventNewsType` string — The unformatted event news type currently detected
        - `pepLevels` string[], nullable — The PEP levels that are currently detected
        - `sanctionLists` string[], nullable — The sanction lists that are currently detected
      - `riskScore` number
      - `sigmaID` string
    - `trueMatches` ResponseMatch[], nullable — Matches that are in-force for this entity. These influence risk, indicators, and profile data.
      - `aliases` string[], nullable
      - `birthDates` SigmaidDateWithSource[], nullable — Birth dates of the entity
        - `humanReadable` string, nullable — A human-readable representation of the range. Show in user interfaces instead of the date range if present
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `until` string, date-time, nullable — If the date is a range, the end of the range
        - `value` string, date-time — The date, or the start of a date range
      - `decisioning` ResponseDecisionState
        - `decidedByDefault` boolean
        - `decisionedAgainst` boolean
        - `hasDecision` boolean
        - `notes` string
        - `rationale` string[], nullable
        - `reviewSubmittedAt` string
        - `reviewedByUserName` string
        - `reviewedByUserURN` string
        - `wasDecisionMadeAgainstThisVersion` boolean
      - `decisioningTimeline` ResponseDecisionTimelineState[], nullable
        - `decidedByDefault` boolean
        - `decisionedAgainst` boolean
        - `notes` string
        - `rationale` string[], nullable
        - `reviewSubmittedAt` string
        - `reviewedByUserName` string
        - `reviewedByUserURN` string
      - `entityName` string
      - `entityType` string, nullable
      - `foundationDates` SigmaidDateWithSource[], nullable — Foundation dates of the entity
        - `humanReadable` string, nullable — A human-readable representation of the range. Show in user interfaces instead of the date range if present
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `until` string, date-time, nullable — If the date is a range, the end of the range
        - `value` string, date-time — The date, or the start of a date range
      - `genders` SigmaidTextWithSource[], nullable — Listed genders of the entity
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `value` string
      - `identifiers` SigmaidIdentification[], nullable — Identification numbers of the entity
        - `country` string, nullable
        - `extras` object, nullable
        - `label` string
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `value` string
      - `indicatorSummaries` SigmaidIndicatorSummary[], nullable
        - `category` string
        - `count` integer
        - `isNetwork` boolean — Indicates whether the indicator is describes this entity or one of its network connections
        - `maxScore` integer
      - `locations` SigmaidLocation[], nullable
        - `address` string
        - `country` string
        - `countryCode` string
        - `fromDate` string
        - `locality` string
        - `majorAdministrativeDivision` string
        - `minorAdministrativeDivision` string
        - `postalCode` string
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `streetName` string
        - `streetNumber` string
        - `toDate` string
        - `type` string
      - `matchDOB` string — The match date from your search date of birth and date of birth proximity
      - `matchLocation` string — The match location from your search countries and location proximity
      - `matchName` string — The alias or name that was most similar to your search term
      - `matchStrength` number — The match strength of the matchName to your search term
      - `riskMetadata` ResponseRiskMetadata
        - `newsMetadata` ResponseNewsMetadata[], nullable — The news events that are currently detected
          - `count` integer — The number of news events for this type that are currently detected
          - `eventNewsType` string — The event news type currently detected
          - `samplePublishers` string[], nullable — A sample of the publishers that are currently detected
          - `unformattedEventNewsType` string — The unformatted event news type currently detected
        - `pepLevels` string[], nullable — The PEP levels that are currently detected
        - `sanctionLists` string[], nullable — The sanction lists that are currently detected
      - `riskScore` number
      - `sigmaID` string
  - `monitored` boolean — Whether the entity will receive automated data and risk updates
  - `notes` ResponseNote[], nullable — The user-provided notes that have been added to the entity
    - `entityUrn` string
    - `id` integer
    - `note` string
    - `updatedAt` string, date-time
    - `userName` string
    - `userUrn` string
  - `organizationURN` string — The primary identifier for the organization that owns the entity
  - `profile` ResponseProfile
    - `facet` ResponseFacetInfo
      - `aircraft` SigmaidFacetAircraft
        - `manufactureDates` SigmaidDateWithSource[], nullable
          - `humanReadable` string, nullable — A human-readable representation of the range. Show in user interfaces instead of the date range if present
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `until` string, date-time, nullable — If the date is a range, the end of the range
          - `value` string, date-time — The date, or the start of a date range
        - `models` SigmaidTextWithSource[], nullable
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `value` string
        - `operators` SigmaidTextWithSource[], nullable
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `value` string
        - `otherIdentifiers` SigmaidIdentification[], nullable
          - `country` string, nullable
          - `extras` object, nullable
          - `label` string
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `value` string
        - `serialNumbers` SigmaidTextWithSource[], nullable
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `value` string
        - `tailNumbers` SigmaidTextWithSource[], nullable
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `value` string
      - `company` SigmaidFacetCompany
        - `corporateNumbers` SigmaidCorporateNumber[], nullable
          - `country` string[], nullable
          - `number` string
          - `register` string[], nullable
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `economicActivities` object, nullable
        - `foundedDates` SigmaidDateWithSource[], nullable
          - `humanReadable` string, nullable — A human-readable representation of the range. Show in user interfaces instead of the date range if present
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `until` string, date-time, nullable — If the date is a range, the end of the range
          - `value` string, date-time — The date, or the start of a date range
        - `incorporationTypes` SigmaidTextWithSource[], nullable
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `value` string
        - `linesOfBusiness` SigmaidTextWithSource[], nullable
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `value` string
        - `statuses` SigmaidTextWithSource[], nullable
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `value` string
      - `person` SigmaidFacetPerson
        - `dobs` SigmaidDateWithSource[], nullable
          - `humanReadable` string, nullable — A human-readable representation of the range. Show in user interfaces instead of the date range if present
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `until` string, date-time, nullable — If the date is a range, the end of the range
          - `value` string, date-time — The date, or the start of a date range
        - `genders` SigmaidTextWithSource[], nullable
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `value` string
        - `identifications` SigmaidIdentification[], nullable
          - `country` string, nullable
          - `extras` object, nullable
          - `label` string
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `value` string
        - `nationalities` SigmaidTextWithSource[], nullable
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `value` string
        - `politicalPositions` SigmaidPoliticalPosition[], nullable
          - `country` string
          - `description` string
          - `from` string, nullable
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `to` string, nullable
      - `vessel` SigmaidFacetVessel
        - `imo` SigmaidTextWithSource
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `value` string
        - `maritimeCallSigns` SigmaidTextWithSource[], nullable
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `value` string
        - `portsOfRegistry` SigmaidTextWithSource[], nullable
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `value` string
        - `types` SigmaidTextWithSource[], nullable
          - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
          - `value` string
    - `kyc` SigmaidKYCEntityData
      - `aliases` SigmaidTextWithSource[], nullable
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `value` string
      - `facts` SigmaidFact[], nullable
        - `label` string
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `value` string
      - `locations` SigmaidLocation[], nullable
        - `address` string
        - `country` string
        - `countryCode` string
        - `fromDate` string
        - `locality` string
        - `majorAdministrativeDivision` string
        - `minorAdministrativeDivision` string
        - `postalCode` string
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `streetName` string
        - `streetNumber` string
        - `toDate` string
        - `type` string
      - `telephones` SigmaidTextWithSource[], nullable
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `value` string
      - `websites` SigmaidTextWithSource[], nullable
        - `sourceAttribution` string[], nullable — Not human readable. This can be used to look up against source information objects.
        - `value` string
  - `reviewState` ResponseEntityReviewState
    - `isAllowedToEndReview` boolean — Whether the current user is allowed to cancel / submit a review
    - `isEditingLocked` boolean — Whether the current user is allowed to change this entity
    - `lastReviewDate` string, date-time, nullable — Time of the last review submission
    - `reviewLockedByName` string, nullable — The name of the user who locked the entity for review
    - `reviewLockedByURN` string, nullable — The URN of the user who locked the entity for review
    - `reviewLockedSince` string, date-time, nullable — The time when the entity was locked for review
    - `reviewStatus` 'no_review_necessary' | 'needs_review' | 'review_locked' | 'reviewed'
    - `unreviewedItems` ResponseUnreviewedItems
      - `numIndicators` integer — The number of indicators inside the entity that require review
      - `numMatches` integer — The number of matches inside the entity that require review
      - `numNews` integer — The number of news events inside the entity that require review
      - `total` integer — The number of items inside the entity that require review
  - `riskMetadata` ResponseRiskMetadata
    - `newsMetadata` ResponseNewsMetadata[], nullable — The news events that are currently detected
      - `count` integer — The number of news events for this type that are currently detected
      - `eventNewsType` string — The event news type currently detected
      - `samplePublishers` string[], nullable — A sample of the publishers that are currently detected
      - `unformattedEventNewsType` string — The unformatted event news type currently detected
    - `pepLevels` string[], nullable — The PEP levels that are currently detected
    - `sanctionLists` string[], nullable — The sanction lists that are currently detected
  - `riskScore` integer — The risk from 0 to 100, where 0 is the lowest risk and 100 is the highest risk
  - `searchParameters` ResponseSearchParameters
    - `aliases` string[], nullable
    - `countries` string[], nullable
    - `dob` string, nullable
    - `entityType` string
  - `updatedAt` string, date-time
  - `urn` string — The primary identifier for user-created entities

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.dev/sigma360/apis/sigma360-api.md) · [All operations](https://skmtc.dev/sigma360/apis/sigma360-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/sigma360/sigma360-api/revisions/fcdda6232c62/schema)