External DocumentationTo learn more, visit the Living Security documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Active | Select to include only active identities when set to true. |
| Cursor | Pagination cursor returned from a previous request. If this value is provided, results continue from the last cursor and any other specified search attributes or terms will be ignored. |
| First Name | Filter results by the identity’s first name. |
| Identity ID | Filter results by the ID of the identity. |
| Last Name | Filter results by the identity’s last name. |
| Page | The page to show results from, defaults to 1. |
| Page Size | The maximum number of results to return, defaults to 20. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Sort | A comma-separated array of sorting criteria. The format of the sort criteria is: field|direction. Direction can be either asc (ascending) or desc (descending) order.Defaults to last_name|asc. When the direction is not specified, defaults to asc. |
| Verified | Select to include only verified identities when set to true. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Business Unit | Filter results by the identity’s business unit. |
| City | Filter results by the identity’s city. |
| Country | Filter results by the identity’s country. |
| Custom Attribute 1 | Filter results by a custom attribute. |
| Custom Attribute 10 | Filter results by a custom attribute. |
| Custom Attribute 2 | Filter results by a custom attribute. |
| Custom Attribute 3 | Filter results by a custom attribute. |
| Custom Attribute 4 | Filter results by a custom attribute. |
| Custom Attribute 5 | Filter results by a custom attribute. |
| Custom Attribute 6 | Filter results by a custom attribute. |
| Custom Attribute 7 | Filter results by a custom attribute. |
| Custom Attribute 8 | Filter results by a custom attribute. |
| Custom Attribute 9 | Filter results by a custom attribute. |
| Department | Filter results by the identity’s department. |
| Employee Level | Filter results by the identity’s employee level. |
| Employee Type | Filter results by the identity’s employee type. |
| Employee Work Status | Filter results by the identity’s work status. |
| Key | Filter results by the key of the identity. |
| Office Location | Filter results by the identity’s office location. |
| Organization | Filter results by the identity’s organization. |
| Region | Filter results by the identity’s region. |
| Title | Filter results by the title of the identity. |
Example Output
{
"data": [
{
"id": "string",
"key": "string",
"active": true,
"verified": true,
"scores": {
"risk_index": {
"human_risk_index": 0,
"updated_at": "2025-04-22T11:43:45.984Z"
},
"behavior_score": {
"behavior_score": 0,
"updated_at": "2025-04-22T11:43:45.984Z"
}
},
"aliases": [
{
"service_id": "string",
"id": "string",
"type": "string",
"value": "string",
"key": "string"
}
],
"created_at": "2025-04-22T11:43:45.984Z",
"last_name": "string",
"first_name": "string",
"department": "string",
"title": "string",
"office_location": "string",
"business_unit": "string",
"employee_level": "string",
"employee_type": "string",
"employee_work_status": "string",
"organization": "string",
"city": "string",
"region": "string",
"country": "string",
"updated_at": "2025-04-22T11:43:45.984Z",
"custom_attr_001": "string",
"custom_attr_002": "string",
"custom_attr_003": "string",
"custom_attr_004": "string",
"custom_attr_005": "string",
"custom_attr_006": "string",
"custom_attr_007": "string",
"custom_attr_008": "string",
"custom_attr_009": "string",
"custom_attr_010": "string"
}
],
"meta": {
"total": 0,
"returned": 0,
"pagination": {
"page_size": 0,
"page": 0,
"cursor": "string",
"next": "string"
}
}
}