---
updatedAt: 2025-11-11T23:14:40.000Z
agentTools:
projectIndex: https://developers.fortresstrust.com/llms.txt
---
# Gets a list of active or inactive identities (Auth)
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "Fortress.Identity Api",
"version": "2.0"
},
"servers": [
{
"url": "https://api.sandbox.fortressapi.com/"
}
],
"paths": {
"/api/compliance/v2/identities": {
"get": {
"tags": [
"Identities"
],
"summary": "Gets a list of active or inactive identities (Auth)",
"parameters": [
{
"name": "Status",
"in": "query",
"schema": {
"$ref": "#/components/schemas/IdentityStatusModel"
}
},
{
"name": "Page",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Identities were successfully retrieved",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserIdentityModelV2PageResponseModel"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"security": [
{
"Bearer": []
}
]
}
}
},
"components": {
"schemas": {
"AddressModel": {
"required": [
"city",
"country",
"street1"
],
"type": "object",
"properties": {
"street1": {
"minLength": 1,
"type": "string",
"description": "Gets or sets the first street"
},
"street2": {
"type": "string",
"description": "Gets or sets the second street",
"nullable": true
},
"postalCode": {
"type": "string",
"description": "Gets or sets the postal code (ZIP code)",
"nullable": true
},
"city": {
"minLength": 1,
"type": "string",
"description": "Gets or sets the city"
},
"state": {
"type": "string",
"description": "Gets or sets the state",
"nullable": true
},
"country": {
"minLength": 1,
"type": "string",
"description": "Gets or sets the country"
}
},
"additionalProperties": false,
"description": "Represents Address model"
},
"BusinessDocumentType": {
"enum": [
"other",
"proofOfAddress",
"proofOfCompanyFormation",
"formationDocument",
"agreement",
"taxIdDocument"
],
"type": "string"
},
"DocumentModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"identityId": {
"type": "string",
"format": "uuid"
},
"personalDocumentType": {
"$ref": "#/components/schemas/PersonalDocumentType"
},
"businessDocumentType": {
"$ref": "#/components/schemas/BusinessDocumentType"
},
"documentReferenceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"documentUuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"documentCheckStatus": {
"$ref": "#/components/schemas/DocumentStatus"
},
"isVerified": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"DocumentStatus": {
"enum": [
"pending",
"automaticReviewInProgress",
"manualReviewNeeded",
"accepted",
"rejected",
"resubmit"
],
"type": "string"
},
"IdentityStatusModel": {
"enum": [
"active",
"inactive"
],
"type": "string"
},
"PageMetadata": {
"type": "object",
"properties": {
"pageCount": {
"type": "integer",
"format": "int32"
},
"resourceCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"PersonalDocumentType": {
"enum": [
"license",
"identificationCard",
"passport"
],
"type": "string"
},
"UserIdentityModelV2": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"kycLevel": {
"type": "string",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/UserIdentityType"
},
"status": {
"$ref": "#/components/schemas/UserIdentityStatus"
},
"address": {
"$ref": "#/components/schemas/AddressModel"
},
"email": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"isSuspended": {
"type": "boolean"
},
"suspendReason": {
"type": "string",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentModel"
},
"nullable": true
}
},
"additionalProperties": false
},
"UserIdentityModelV2PageResponseModel": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserIdentityModelV2"
},
"nullable": true
},
"meta": {
"$ref": "#/components/schemas/PageMetadata"
}
},
"additionalProperties": false
},
"UserIdentityStatus": {
"enum": [
"active",
"inactive",
"inactivationStarted"
],
"type": "string"
},
"UserIdentityType": {
"enum": [
"personal",
"business"
],
"type": "string"
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Put access token in the box below.
For example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6I",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": []
}
],
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
}
}
```