Sign in

v1

latestOpenAPI 3.1.02026-08-042010999.7 KB
Monitoring: Entity Creation

Create one Entity

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.

post/entities/create

Request body

entityGroupIDsinteger[] nullable required
filterSetIDinteger required

Example request

{
  "search": {
    "aliases": [
      "InGen, InGen Corp"
    ],
    "countries": [
      "US"
    ],
    "customerKey": "ABC1234567890",
    "dob": "1993-06-11",
    "entityName": "InGen Corporation",
    "entityType": "company"
  }
}

Response

OK

archivedAtstring date-time nullable

Not null if the entity has been archived. The time when the entity was archived

createdAtstring date-time
customerKeystring

Optional. A user-provided identifier that will be returned in alerts and monitoring. Any format.

entityNamestring
entityType'company' | 'person' | 'vessel' | 'aircraft' | '' nullable

The resolved entity type

escalatedboolean
escalatedByUserNamestring nullable
escalatedByUserUrnstring nullable
escalatedTimestring date-time nullable
filterSetIDinteger
filterSetNamestring
hasOpenAlertboolean

Whether the entity has an open alert

monitoredboolean

Whether the entity will receive automated data and risk updates

organizationURNstring

The primary identifier for the organization that owns the entity

riskScoreinteger

The risk from 0 to 100, where 0 is the lowest risk and 100 is the highest risk

updatedAtstring date-time
urnstring

The primary identifier for user-created entities

Example response

{
  "customerKey": "ABC1234567890",
  "dispositionState": {
    "dispositionSetAtTime": "2020-01-01T00:00:00Z",
    "dispositionSetByUserName": "John Hammond",
    "dispositionSetByUserURN": "urn:sigma:user:f6ba1259b3a35de80aab7733c5d5",
    "dispositionState": "pending"
  },
  "entityName": "InGen Corporation",
  "entityType": "company",
  "filterSetName": "Investigative Due Diligence",
  "indicatorSummaries": [
    {
      "category": "Sanctions",
      "count": 2,
      "maxScore": 100
    }
  ],
  "indicators": {
    "acceptedRisks": [
      {
        "category": "Sanctions",
        "causalSigmaID": {
          "aliases": [
            "InGen, InGen Corp"
          ],
          "birthDates": [
            {
              "humanReadable": "Circa 1980",
              "sourceAttribution": [
                "abcd1234//1234567890"
              ],
              "until": "2023-01-01T00:00:00Z",
              "value": "2023-01-01T00:00:00Z"
            }
          ],
          "entityName": "InGen Corporation",
          "entityType": "company",
          "foundationDates": [
            {
              "humanReadable": "Circa 1980",
              "sourceAttribution": [
                "abcd1234//1234567890"
              ],
              "until": "2023-01-01T00:00:00Z",
              "value": "2023-01-01T00:00:00Z"
            }
          ],
          "indicatorSummaries": [
            {
              "category": "Sanctions",
              "count": 2,
              "maxScore": 100
            }
          ],
          "locations": [
            {
              "address": "10 Downing St, London SW1A 2AB, United Kingdom",
              "country": "United Kingdom",
              "countryCode": "GB",
              "fromDate": "1684-05-20",
              "locality": "London",
              "majorAdministrativeDivision": "England",
              "minorAdministrativeDivision": "City of Westminster",
              "postalCode": "SW1A 2AB",
              "sourceAttribution": [
                "abcd1234//1234567890"
              ],
              "streetName": "Downing St",
              "streetNumber": "10",
              "toDate": "2020-05-20",
              "type": "Residence"
            }
          ],
          "sigmaID": "3BX869NCJTZ5K"
        },
        "code": "SAN006",
        "date": "2023-01-01T00:00:00Z",
        "description": "Swiss State Secretariat for Economic Affairs",
        "name": "Appears on sanction list",
        "relationshipChain": {
          "edges": [
            {
              "inverseRelationship": "Is Subsidiary Of",
              "relationship": "Has Subsidiary"
            }
          ],
          "entities": [
            {
              "entityName": "InGen Corporation",
              "entityType": "company",
              "sigmaID": "3BX869NCJTZ5K"
            }
          ]
        },
        "score": 90,
        "sourceAttribution": [
          "abcd1234//1234567890"
        ],
        "subcategory": "sanctions_swiss",
        "urn": "urn:sigma:indicator:5VpYSbsw2R6UaVxFilHv_TpJ5wJZocEzMAaLvFkVJAg="
      }
    ],
    "activeRisks": [
      {
        "category": "Sanctions",
        "causalSigmaID": {
          "aliases": [
            "InGen, InGen Corp"
          ],
          "birthDates": [
            {
              "humanReadable": "Circa 1980",
              "sourceAttribution": [
                "abcd1234//1234567890"
              ],
              "until": "2023-01-01T00:00:00Z",
              "value": "2023-01-01T00:00:00Z"
            }
          ],
          "entityName": "InGen Corporation",
          "entityType": "company",
          "foundationDates": [
            {
              "humanReadable": "Circa 1980",
              "sourceAttribution": [
                "abcd1234//1234567890"
              ],
              "until": "2023-01-01T00:00:00Z",
              "value": "2023-01-01T00:00:00Z"
            }
          ],
          "indicatorSummaries": [
            {
              "category": "Sanctions",
              "count": 2,
              "maxScore": 100
            }
          ],
          "locations": [
            {
              "address": "10 Downing St, London SW1A 2AB, United Kingdom",
              "country": "United Kingdom",
              "countryCode": "GB",
              "fromDate": "1684-05-20",
              "locality": "London",
              "majorAdministrativeDivision": "England",
              "minorAdministrativeDivision": "City of Westminster",
              "postalCode": "SW1A 2AB",
              "sourceAttribution": [
                "abcd1234//1234567890"
              ],
              "streetName": "Downing St",
              "streetNumber": "10",
              "toDate": "2020-05-20",
              "type": "Residence"
            }
          ],
          "sigmaID": "3BX869NCJTZ5K"
        },
        "code": "SAN006",
        "date": "2023-01-01T00:00:00Z",
        "description": "Swiss State Secretariat for Economic Affairs",
        "name": "Appears on sanction list",
        "relationshipChain": {
          "edges": [
            {
              "inverseRelationship": "Is Subsidiary Of",
              "relationship": "Has Subsidiary"
            }
          ],
          "entities": [
            {
              "entityName": "InGen Corporation",
              "entityType": "company",
              "sigmaID": "3BX869NCJTZ5K"
            }
          ]
        },
        "score": 90,
        "sourceAttribution": [
          "abcd1234//1234567890"
        ],
        "subcategory": "sanctions_swiss",
        "urn": "urn:sigma:indicator:5VpYSbsw2R6UaVxFilHv_TpJ5wJZocEzMAaLvFkVJAg="
      }
    ],
    "risksRequiringReview": [
      {
        "category": "Sanctions",
        "causalSigmaID": {
          "aliases": [
            "InGen, InGen Corp"
          ],
          "birthDates": [
            {
              "humanReadable": "Circa 1980",
              "sourceAttribution": [
                "abcd1234//1234567890"
              ],
              "until": "2023-01-01T00:00:00Z",
              "value": "2023-01-01T00:00:00Z"
            }
          ],
          "entityName": "InGen Corporation",
          "entityType": "company",
          "foundationDates": [
            {
              "humanReadable": "Circa 1980",
              "sourceAttribution": [
                "abcd1234//1234567890"
              ],
              "until": "2023-01-01T00:00:00Z",
              "value": "2023-01-01T00:00:00Z"
            }
          ],
          "indicatorSummaries": [
            {
              "category": "Sanctions",
              "count": 2,
              "maxScore": 100
            }
          ],
          "locations": [
            {
              "address": "10 Downing St, London SW1A 2AB, United Kingdom",
              "country": "United Kingdom",
              "countryCode": "GB",
              "fromDate": "1684-05-20",
              "locality": "London",
              "majorAdministrativeDivision": "England",
              "minorAdministrativeDivision": "City of Westminster",
              "postalCode": "SW1A 2AB",
              "sourceAttribution": [
                "abcd1234//1234567890"
              ],
              "streetName": "Downing St",
              "streetNumber": "10",
              "toDate": "2020-05-20",
              "type": "Residence"
            }
          ],
          "sigmaID": "3BX869NCJTZ5K"
        },
        "code": "SAN006",
        "date": "2023-01-01T00:00:00Z",
        "description": "Swiss State Secretariat for Economic Affairs",
        "name": "Appears on sanction list",
        "relationshipChain": {
          "edges": [
            {
              "inverseRelationship": "Is Subsidiary Of",
              "relationship": "Has Subsidiary"
            }
          ],
          "entities": [
            {
              "entityName": "InGen Corporation",
              "entityType": "company",
              "sigmaID": "3BX869NCJTZ5K"
            }
          ]
        },
        "score": 90,
        "sourceAttribution": [
          "abcd1234//1234567890"
        ],
        "subcategory": "sanctions_swiss",
        "urn": "urn:sigma:indicator:5VpYSbsw2R6UaVxFilHv_TpJ5wJZocEzMAaLvFkVJAg="
      }
    ]
  },
  "matches": {
    "matchesRequiringReview": [
      {
        "aliases": [
          "InGen Corp."
        ],
        "birthDates": [
          {
            "humanReadable": "Circa 1980",
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "until": "2023-01-01T00:00:00Z",
            "value": "2023-01-01T00:00:00Z"
          }
        ],
        "entityName": "InGen Corporation",
        "entityType": "company",
        "foundationDates": [
          {
            "humanReadable": "Circa 1980",
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "until": "2023-01-01T00:00:00Z",
            "value": "2023-01-01T00:00:00Z"
          }
        ],
        "genders": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "value": "<text>"
          }
        ],
        "identifiers": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ]
          }
        ],
        "indicatorSummaries": [
          {
            "category": "Sanctions",
            "count": 2,
            "maxScore": 100
          }
        ],
        "locations": [
          {
            "address": "10 Downing St, London SW1A 2AB, United Kingdom",
            "country": "United Kingdom",
            "countryCode": "GB",
            "fromDate": "1684-05-20",
            "locality": "London",
            "majorAdministrativeDivision": "England",
            "minorAdministrativeDivision": "City of Westminster",
            "postalCode": "SW1A 2AB",
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "streetName": "Downing St",
            "streetNumber": "10",
            "toDate": "2020-05-20",
            "type": "Residence"
          }
        ],
        "matchDOB": "1948-01-15T00:00:00Z",
        "matchLocation": "us",
        "matchStrength": 0.8,
        "riskMetadata": {
          "newsMetadata": [
            {
              "count": 3,
              "eventNewsType": "Legal Risk",
              "samplePublishers": [
                "The New York Times"
              ],
              "unformattedEventNewsType": "legal_risk"
            }
          ],
          "pepLevels": [
            "PEP Level 1"
          ],
          "sanctionLists": [
            "sanctions_ofac"
          ]
        },
        "sigmaID": "3BX869NCJTZ5K"
      }
    ],
    "negativelyDecisionedMatches": [
      {
        "aliases": [
          "InGen Corp."
        ],
        "birthDates": [
          {
            "humanReadable": "Circa 1980",
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "until": "2023-01-01T00:00:00Z",
            "value": "2023-01-01T00:00:00Z"
          }
        ],
        "entityName": "InGen Corporation",
        "entityType": "company",
        "foundationDates": [
          {
            "humanReadable": "Circa 1980",
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "until": "2023-01-01T00:00:00Z",
            "value": "2023-01-01T00:00:00Z"
          }
        ],
        "genders": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "value": "<text>"
          }
        ],
        "identifiers": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ]
          }
        ],
        "indicatorSummaries": [
          {
            "category": "Sanctions",
            "count": 2,
            "maxScore": 100
          }
        ],
        "locations": [
          {
            "address": "10 Downing St, London SW1A 2AB, United Kingdom",
            "country": "United Kingdom",
            "countryCode": "GB",
            "fromDate": "1684-05-20",
            "locality": "London",
            "majorAdministrativeDivision": "England",
            "minorAdministrativeDivision": "City of Westminster",
            "postalCode": "SW1A 2AB",
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "streetName": "Downing St",
            "streetNumber": "10",
            "toDate": "2020-05-20",
            "type": "Residence"
          }
        ],
        "matchDOB": "1948-01-15T00:00:00Z",
        "matchLocation": "us",
        "matchStrength": 0.8,
        "riskMetadata": {
          "newsMetadata": [
            {
              "count": 3,
              "eventNewsType": "Legal Risk",
              "samplePublishers": [
                "The New York Times"
              ],
              "unformattedEventNewsType": "legal_risk"
            }
          ],
          "pepLevels": [
            "PEP Level 1"
          ],
          "sanctionLists": [
            "sanctions_ofac"
          ]
        },
        "sigmaID": "3BX869NCJTZ5K"
      }
    ],
    "trueMatches": [
      {
        "aliases": [
          "InGen Corp."
        ],
        "birthDates": [
          {
            "humanReadable": "Circa 1980",
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "until": "2023-01-01T00:00:00Z",
            "value": "2023-01-01T00:00:00Z"
          }
        ],
        "entityName": "InGen Corporation",
        "entityType": "company",
        "foundationDates": [
          {
            "humanReadable": "Circa 1980",
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "until": "2023-01-01T00:00:00Z",
            "value": "2023-01-01T00:00:00Z"
          }
        ],
        "genders": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "value": "<text>"
          }
        ],
        "identifiers": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ]
          }
        ],
        "indicatorSummaries": [
          {
            "category": "Sanctions",
            "count": 2,
            "maxScore": 100
          }
        ],
        "locations": [
          {
            "address": "10 Downing St, London SW1A 2AB, United Kingdom",
            "country": "United Kingdom",
            "countryCode": "GB",
            "fromDate": "1684-05-20",
            "locality": "London",
            "majorAdministrativeDivision": "England",
            "minorAdministrativeDivision": "City of Westminster",
            "postalCode": "SW1A 2AB",
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "streetName": "Downing St",
            "streetNumber": "10",
            "toDate": "2020-05-20",
            "type": "Residence"
          }
        ],
        "matchDOB": "1948-01-15T00:00:00Z",
        "matchLocation": "us",
        "matchStrength": 0.8,
        "riskMetadata": {
          "newsMetadata": [
            {
              "count": 3,
              "eventNewsType": "Legal Risk",
              "samplePublishers": [
                "The New York Times"
              ],
              "unformattedEventNewsType": "legal_risk"
            }
          ],
          "pepLevels": [
            "PEP Level 1"
          ],
          "sanctionLists": [
            "sanctions_ofac"
          ]
        },
        "sigmaID": "3BX869NCJTZ5K"
      }
    ]
  },
  "monitored": true,
  "organizationURN": "urn:sigma:organization:ingen-corp",
  "profile": {
    "facet": {
      "aircraft": {
        "manufactureDates": [
          {
            "humanReadable": "Circa 1980",
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "until": "2023-01-01T00:00:00Z",
            "value": "2023-01-01T00:00:00Z"
          }
        ],
        "models": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "value": "<text>"
          }
        ],
        "operators": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "value": "<text>"
          }
        ],
        "otherIdentifiers": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ]
          }
        ],
        "serialNumbers": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "value": "<text>"
          }
        ],
        "tailNumbers": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "value": "<text>"
          }
        ]
      },
      "company": {
        "corporateNumbers": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ]
          }
        ],
        "foundedDates": [
          {
            "humanReadable": "Circa 1980",
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "until": "2023-01-01T00:00:00Z",
            "value": "2023-01-01T00:00:00Z"
          }
        ],
        "incorporationTypes": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "value": "<text>"
          }
        ],
        "linesOfBusiness": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "value": "<text>"
          }
        ],
        "statuses": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "value": "<text>"
          }
        ]
      },
      "person": {
        "dobs": [
          {
            "humanReadable": "Circa 1980",
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "until": "2023-01-01T00:00:00Z",
            "value": "2023-01-01T00:00:00Z"
          }
        ],
        "genders": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "value": "<text>"
          }
        ],
        "identifications": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ]
          }
        ],
        "nationalities": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "value": "<text>"
          }
        ],
        "politicalPositions": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ]
          }
        ]
      },
      "vessel": {
        "imo": {
          "sourceAttribution": [
            "abcd1234//1234567890"
          ],
          "value": "<text>"
        },
        "maritimeCallSigns": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "value": "<text>"
          }
        ],
        "portsOfRegistry": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "value": "<text>"
          }
        ],
        "types": [
          {
            "sourceAttribution": [
              "abcd1234//1234567890"
            ],
            "value": "<text>"
          }
        ]
      }
    },
    "kyc": {
      "aliases": [
        {
          "sourceAttribution": [
            "abcd1234//1234567890"
          ],
          "value": "<text>"
        }
      ],
      "facts": [
        {
          "label": "Notes",
          "sourceAttribution": [
            "abcd1234//1234567890"
          ],
          "value": "<text>"
        }
      ],
      "locations": [
        {
          "address": "10 Downing St, London SW1A 2AB, United Kingdom",
          "country": "United Kingdom",
          "countryCode": "GB",
          "fromDate": "1684-05-20",
          "locality": "London",
          "majorAdministrativeDivision": "England",
          "minorAdministrativeDivision": "City of Westminster",
          "postalCode": "SW1A 2AB",
          "sourceAttribution": [
            "abcd1234//1234567890"
          ],
          "streetName": "Downing St",
          "streetNumber": "10",
          "toDate": "2020-05-20",
          "type": "Residence"
        }
      ],
      "telephones": [
        {
          "sourceAttribution": [
            "abcd1234//1234567890"
          ],
          "value": "<text>"
        }
      ],
      "websites": [
        {
          "sourceAttribution": [
            "abcd1234//1234567890"
          ],
          "value": "<text>"
        }
      ]
    }
  },
  "reviewState": {
    "lastReviewDate": "2020-01-01T00:00:00Z",
    "reviewLockedByName": "John Hammond",
    "reviewLockedByURN": "urn:sigma:user:f6ba1259b3a35de80aab7733c5d5",
    "reviewLockedSince": "2020-01-01T00:00:00Z",
    "reviewStatus": "needs_review",
    "unreviewedItems": {
      "numIndicators": 5,
      "numMatches": 2,
      "numNews": 16,
      "total": 3
    }
  },
  "riskMetadata": {
    "newsMetadata": [
      {
        "count": 3,
        "eventNewsType": "Legal Risk",
        "samplePublishers": [
          "The New York Times"
        ],
        "unformattedEventNewsType": "legal_risk"
      }
    ],
    "pepLevels": [
      "PEP Level 1"
    ],
    "sanctionLists": [
      "sanctions_ofac"
    ]
  },
  "riskScore": 50,
  "searchParameters": {
    "aliases": [
      "Ingen Corp."
    ],
    "countries": [
      "CR"
    ],
    "entityType": "company"
  },
  "urn": "urn:sigma:entity:123e4567-e89b-12d3-a456-426614174000"
}