v1

latestOpenAPI 3.1.02026-08-042010999.7 KB

Monitoring: Entity Management

Retrieve a paginated list of entity summaries

Use this endpoint to browse your monitored entity population. It is filterable and shows all of your entities at a glance.

post/entities

Query parameters

sortBystring nullable

The field name that you want to sort by. Many fields in the response are sortable, but not all.

sortOrderstring nullable

ASC or DESC. Defaults: DESC

Example:asc

ASC or DESC. Defaults: DESC

pageinteger

Page number, 1-indexed. Default: 1

Example:1

Page number, 1-indexed. Default: 1

pageSizeinteger

Number of results per page. Maximum: 100, Default: 10

Example:10

Number of results per page. Maximum: 100, Default: 10

Request body

filtersstring[] nullable

pageinteger

Page number, 1-indexed. Default: 1

pageSizeinteger

Number of results per page. Maximum: 100, Default: 10

sortBystring nullable

The field name that you want to sort by. Many fields in the response are sortable, but not all.

sortOrderstring nullable

ASC or DESC. Defaults: DESC

totalinteger

Total number of results. Ignored in requests, used in responses.

Example request

{
  "page": 1,
  "pageSize": 10,
  "sortOrder": "asc",
  "total": 15000
}

Response

pageinteger

Page number, 1-indexed. Default: 1

pageSizeinteger

Number of results per page. Maximum: 100, Default: 10

totalinteger

Total number of results. Ignored in requests, used in responses.

Example response

{
  "entities": [
    {
      "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
        }
      ],
      "monitored": true,
      "organizationURN": "urn:sigma:organization:ingen-corp",
      "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, InGen Corp"
        ],
        "countries": [
          "US"
        ],
        "customerKey": "ABC1234567890",
        "dob": "1993-06-11",
        "entityName": "InGen Corporation",
        "entityType": "company"
      },
      "urn": "urn:sigma:entity:123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "page": 1,
  "pageSize": 10,
  "total": 15000
}