> For the complete documentation index, see [llms.txt](https://docs.meeco.me/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.meeco.me/openapi-docs/svx-api/models.md).

# Models

## The PlatformUserDto object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"PlatformUserDto":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"email_verified":{"type":"boolean"},"did":{"type":"string"},"jwk_thumbprint_uri":{"type":"string"},"name":{"type":"string"},"given_name":{"type":"string"},"family_name":{"type":"string"},"is_active":{"type":"boolean"},"created_at":{"format":"date-time","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["id","email","email_verified","did","jwk_thumbprint_uri","name","given_name","family_name","is_active","created_at","updated_at"]}}}}
```

## The PlatformUserResponseDto object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"PlatformUserResponseDto":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/PlatformUserDto"}},"required":["user"]},"PlatformUserDto":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"email_verified":{"type":"boolean"},"did":{"type":"string"},"jwk_thumbprint_uri":{"type":"string"},"name":{"type":"string"},"given_name":{"type":"string"},"family_name":{"type":"string"},"is_active":{"type":"boolean"},"created_at":{"format":"date-time","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["id","email","email_verified","did","jwk_thumbprint_uri","name","given_name","family_name","is_active","created_at","updated_at"]}}}}
```

## The PlatformErrorResponseDto object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"PlatformErrorResponseDto":{"type":"object","properties":{}}}}}
```

## The PlatformUpdateUserDto object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"PlatformUpdateUserDto":{"type":"object","properties":{"given_name":{"type":"string"},"family_name":{"type":"string"}}}}}}
```

## The PlatformUpdateUserPayloadDto object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"PlatformUpdateUserPayloadDto":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/PlatformUpdateUserDto"}},"required":["user"]},"PlatformUpdateUserDto":{"type":"object","properties":{"given_name":{"type":"string"},"family_name":{"type":"string"}}}}}}
```

## The PlatformUpdatePasswordDto object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"PlatformUpdatePasswordDto":{"type":"object","properties":{"old_password":{"type":"string"},"new_password":{"type":"string"},"confirm_password":{"type":"string"}},"required":["old_password","new_password","confirm_password"]}}}}
```

## The PlatformUpdatePasswordPayloadDto object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"PlatformUpdatePasswordPayloadDto":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/PlatformUpdatePasswordDto"}},"required":["user"]},"PlatformUpdatePasswordDto":{"type":"object","properties":{"old_password":{"type":"string"},"new_password":{"type":"string"},"confirm_password":{"type":"string"}},"required":["old_password","new_password","confirm_password"]}}}}
```

## The PlatformErrorResponseModel object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"PlatformErrorResponseModel":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"object"},"http_code":{"type":"number"},"extra_info":{"type":"object"},"requested_language":{"type":"string"},"message_in_requested_language":{"type":"boolean"}},"required":["error","message","http_code","extra_info","requested_language","message_in_requested_language"]}}}}
```

## The PlatformErrorsResponseModelDto object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"PlatformErrorsResponseModelDto":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/PlatformErrorResponseModel"}}},"required":["errors"]},"PlatformErrorResponseModel":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"object"},"http_code":{"type":"number"},"extra_info":{"type":"object"},"requested_language":{"type":"string"},"message_in_requested_language":{"type":"boolean"}},"required":["error","message","http_code","extra_info","requested_language","message_in_requested_language"]}}}}
```

## The PlatformCreateInvitationDto object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"PlatformCreateInvitationDto":{"type":"object","properties":{"email":{"type":"string"},"given_name":{"type":"string"},"family_name":{"type":"string"},"message":{"type":"string","nullable":true}},"required":["email","given_name","family_name"]}}}}
```

## The PlatformCreateInvitationPayloadDto object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"PlatformCreateInvitationPayloadDto":{"type":"object","properties":{"invitation":{"$ref":"#/components/schemas/PlatformCreateInvitationDto"}},"required":["invitation"]},"PlatformCreateInvitationDto":{"type":"object","properties":{"email":{"type":"string"},"given_name":{"type":"string"},"family_name":{"type":"string"},"message":{"type":"string","nullable":true}},"required":["email","given_name","family_name"]}}}}
```

## The PlatformInvitationResponseModelDto object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"PlatformInvitationResponseModelDto":{"type":"object","properties":{"id":{"type":"string"},"to":{"type":"string"},"status":{"type":"string","enum":["pending","accepted","expired"]},"token":{"type":"string"},"user_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"accepted_at":{"format":"date-time","type":"string"},"expires_at":{"format":"date-time","type":"string"},"message":{"type":"string"},"tenant_id":{"type":"string"},"org_id":{"type":"string"},"presentation_request_url":{"type":"string","deprecated":true},"open_id_presentation_request_url":{"type":"string","deprecated":true},"given_name":{"type":"string"},"family_name":{"type":"string"},"email":{"type":"string"}},"required":["id","to","status","token","user_id","created_at","accepted_at","expires_at","message","tenant_id","org_id","presentation_request_url","open_id_presentation_request_url","given_name","family_name","email"]}}}}
```

## The PlatformInvitationResponseDto object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"PlatformInvitationResponseDto":{"type":"object","properties":{"invitation":{"$ref":"#/components/schemas/PlatformInvitationResponseModelDto"}},"required":["invitation"]},"PlatformInvitationResponseModelDto":{"type":"object","properties":{"id":{"type":"string"},"to":{"type":"string"},"status":{"type":"string","enum":["pending","accepted","expired"]},"token":{"type":"string"},"user_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"accepted_at":{"format":"date-time","type":"string"},"expires_at":{"format":"date-time","type":"string"},"message":{"type":"string"},"tenant_id":{"type":"string"},"org_id":{"type":"string"},"presentation_request_url":{"type":"string","deprecated":true},"open_id_presentation_request_url":{"type":"string","deprecated":true},"given_name":{"type":"string"},"family_name":{"type":"string"},"email":{"type":"string"}},"required":["id","to","status","token","user_id","created_at","accepted_at","expires_at","message","tenant_id","org_id","presentation_request_url","open_id_presentation_request_url","given_name","family_name","email"]}}}}
```

## The PlatformMeta object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"PlatformMeta":{"type":"object","properties":{"order_by":{"type":"string"},"order":{"type":"string","enum":["ASC","DESC"]},"order_from_params":{"type":"boolean"},"per_page":{"type":"number"},"per_page_from_params":{"type":"boolean"},"records_count":{"type":"number"},"page":{"type":"number"},"page_count":{"type":"number"}},"required":["order_by","order","order_from_params","per_page","per_page_from_params","records_count","page","page_count"]}}}}
```

## The PlatformInvitationsResponseDto object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"PlatformInvitationsResponseDto":{"type":"object","properties":{"invitations":{"type":"array","items":{"$ref":"#/components/schemas/PlatformInvitationResponseModelDto"}},"meta":{"$ref":"#/components/schemas/PlatformMeta"}},"required":["invitations","meta"]},"PlatformInvitationResponseModelDto":{"type":"object","properties":{"id":{"type":"string"},"to":{"type":"string"},"status":{"type":"string","enum":["pending","accepted","expired"]},"token":{"type":"string"},"user_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"accepted_at":{"format":"date-time","type":"string"},"expires_at":{"format":"date-time","type":"string"},"message":{"type":"string"},"tenant_id":{"type":"string"},"org_id":{"type":"string"},"presentation_request_url":{"type":"string","deprecated":true},"open_id_presentation_request_url":{"type":"string","deprecated":true},"given_name":{"type":"string"},"family_name":{"type":"string"},"email":{"type":"string"}},"required":["id","to","status","token","user_id","created_at","accepted_at","expires_at","message","tenant_id","org_id","presentation_request_url","open_id_presentation_request_url","given_name","family_name","email"]},"PlatformMeta":{"type":"object","properties":{"order_by":{"type":"string"},"order":{"type":"string","enum":["ASC","DESC"]},"order_from_params":{"type":"boolean"},"per_page":{"type":"number"},"per_page_from_params":{"type":"boolean"},"records_count":{"type":"number"},"page":{"type":"number"},"page_count":{"type":"number"}},"required":["order_by","order","order_from_params","per_page","per_page_from_params","records_count","page","page_count"]}}}}
```

## The UtilitiesBlobUploadUrlRequest object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"UtilitiesBlobUploadUrlRequest":{"properties":{"content_type":{"description":"content type of the file to be uploaded","type":"string"},"filename":{"description":"name of the file to be uploaded","type":"string"}},"required":["filename"],"type":"object"}}}}
```

## The UtilitiesWalletDeploymentCreated object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"UtilitiesWalletDeploymentCreated":{"properties":{"instance_id":{"description":"The SVX Wallet instance ID","format":"uuid","type":"string"}},"required":["instance_id"],"type":"object"}}}}
```

## The UtilitiesDeploymentWithoutLog object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"UtilitiesDeploymentWithoutLog":{"properties":{"all_workflows_successful":{"description":"Whether all workflows completed successfully","nullable":true,"type":"boolean"},"current_user_id":{"description":"Current user ID","format":"uuid","nullable":true,"type":"string"},"db_name":{"description":"PostgreSQL database name for the SVX Wallet instance","nullable":true,"type":"string"},"description":{"description":"Optional human-readable description for this SVX Wallet instance","nullable":true,"type":"string"},"error":{"description":"Error message","nullable":true,"type":"string"},"external_idp_client_id":{"description":"External IdP client ID","nullable":true,"type":"string"},"git_workflow":{"description":"Git workflow status","nullable":true,"type":"string"},"git_workflow_duration":{"description":"Git workflow duration in milliseconds","nullable":true,"type":"integer"},"git_workflow_log":{"description":"Git workflow event log","items":{"$ref":"#/components/schemas/UtilitiesWorkflowEvent"},"type":"array"},"inserted_at":{"description":"Creation timestamp","format":"date-time","type":"string"},"instance_config_for_workflow_retries":{"description":"Config data for workflow retries","nullable":true,"type":"object"},"instance_id":{"description":"SVX Wallet instance ID","type":"string"},"internal_domain":{"description":"Internal domain for the deployment","nullable":true,"type":"string"},"online_at":{"description":"Timestamp when deployment went online","format":"date-time","nullable":true,"type":"string"},"online_check_counter":{"default":0,"description":"Counter for online status checks","type":"integer"},"online_status_checked_at":{"description":"Timestamp when online status was last checked","format":"date-time","nullable":true,"type":"string"},"org_id":{"description":"Organisation ID","nullable":true,"type":"string"},"org_name":{"description":"Organisation name","nullable":true,"type":"string"},"public_domain":{"description":"Public domain URL for the deployment","nullable":true,"type":"string"},"redis_db":{"description":"Redis database number","type":"integer"},"status":{"description":"Current deployment status","type":"string"},"tenant_id":{"description":"Tenant ID","nullable":true,"type":"string"},"tenant_name":{"description":"Tenant name","nullable":true,"type":"string"},"versions":{"description":"Version information for this deployment","nullable":true,"properties":{"deployed_version":{"description":"Full semver of the currently deployed version (e.g. \"0.1.0\")","nullable":true,"type":"string"},"version_history":{"description":"History of deployed versions and upgrades","items":{"type":"object"},"nullable":true,"type":"array"},"version_series":{"description":"Version series this deployment is locked to (e.g. \"0.1\")","nullable":true,"type":"string"}},"type":"object"},"workflow_reports":{"description":"Reports from workflow executions","nullable":true,"type":"object"}},"required":["instance_id","redis_db","status","git_workflow_log","online_check_counter","inserted_at"],"type":"object"},"UtilitiesWorkflowEvent":{"properties":{"status":{"description":"Event status","type":"string"},"timestamp":{"description":"Event timestamp","format":"date-time","type":"string"}},"required":["status","timestamp"],"type":"object"}}}}
```

## The UtilitiesBlobInfoResponse object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"UtilitiesBlobInfoResponse":{"properties":{"blob":{"$ref":"#/components/schemas/UtilitiesBlobInfo"}},"required":["blob"],"type":"object"},"UtilitiesBlobInfo":{"properties":{"content_type":{"description":"file content type","type":"string"},"filename":{"description":"file name","type":"string"},"key":{"description":"the key under which the file will be stored in the cloud","type":"string"},"read_url":{"description":"the URL to which a client can upload a file. The upload is done via `PUT` and there should be header `x-ms-blob-type: BlockBlob`","format":"uri","type":"string"},"storage_backend_name":{"description":"name of the cloud storage configuration","type":"string"},"storage_backend_type":{"description":"which cloud provider the file is histed at","type":"string"},"upload_headers":{"description":"HTTP headers which must be added to the HTTP upload call","type":"object"},"upload_url":{"description":"the URL to which a client can upload a file. The upload is done via `PUT` and there should be header `x-ms-blob-type: BlockBlob`","format":"uri","type":"string"},"upload_url_expires_in_seconds":{"description":"seconds during which the upload URL is valid","type":"integer"},"uploaded":{"description":"","type":"boolean"}},"required":["key","filename","content_type","uploaded","storage_backend_name","storage_backend_type"],"type":"object"}}}}
```

## The UtilitiesPaginationMeta object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"UtilitiesPaginationMeta":{"properties":{"order":{"description":"Order direcction: desc or asc","type":"string"},"order_by":{"description":"Field by which ordering is done","type":"string"},"order_from_params":{"description":"Defines whether the ordering direction is taken from request parameters or is the default value","type":"boolean"},"page":{"description":"Page number","type":"integer"},"page_count":{"description":"Total number of pages","type":"integer"},"per_page":{"description":"Records per page","type":"integer"},"per_page_from_params":{"description":"Defines whether the the number of recors is taken from request parameters or is the default value","type":"boolean"},"records_count":{"description":"Total number of metrics","type":"integer"}},"required":["order","order_by","order_from_params","page","page_count","per_page","per_page_from_params","records_count"],"type":"object"}}}}
```

## The UtilitiesError object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"UtilitiesError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","http_code","message","file","line","args"],"type":"object"}}}}
```

## The UtilitiesDeployment object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"UtilitiesDeployment":{"properties":{"all_workflows_successful":{"description":"Whether all workflows completed successfully","nullable":true,"type":"boolean"},"current_user_id":{"description":"Current user ID","format":"uuid","nullable":true,"type":"string"},"db_name":{"description":"PostgreSQL database name for the SVX Wallet instance","nullable":true,"type":"string"},"description":{"description":"Optional human-readable description for this SVX Wallet instance","nullable":true,"type":"string"},"error":{"description":"Error message","nullable":true,"type":"string"},"external_idp_client_id":{"description":"External IdP client ID","nullable":true,"type":"string"},"git_workflow":{"description":"Git workflow status","nullable":true,"type":"string"},"git_workflow_duration":{"description":"Git workflow duration in milliseconds","nullable":true,"type":"integer"},"inserted_at":{"description":"Creation timestamp","format":"date-time","type":"string"},"instance_config_for_workflow_retries":{"description":"Config data for workflow retries","nullable":true,"type":"object"},"instance_id":{"description":"SVX Wallet instance ID","type":"string"},"internal_domain":{"description":"Internal domain for the deployment","nullable":true,"type":"string"},"online_at":{"description":"Timestamp when deployment went online","format":"date-time","nullable":true,"type":"string"},"online_check_counter":{"default":0,"description":"Counter for online status checks","type":"integer"},"online_status_checked_at":{"description":"Timestamp when online status was last checked","format":"date-time","nullable":true,"type":"string"},"org_id":{"description":"Organisation ID","nullable":true,"type":"string"},"org_name":{"description":"Organisation name","nullable":true,"type":"string"},"public_domain":{"description":"Public domain URL for the deployment","nullable":true,"type":"string"},"redis_db":{"description":"Redis database number","type":"integer"},"status":{"description":"Current deployment status","type":"string"},"tenant_id":{"description":"Tenant ID","nullable":true,"type":"string"},"tenant_name":{"description":"Tenant name","nullable":true,"type":"string"},"versions":{"description":"Version information for this deployment","nullable":true,"properties":{"deployed_version":{"description":"Full semver of the currently deployed version (e.g. \"0.1.0\")","nullable":true,"type":"string"},"version_history":{"description":"History of deployed versions and upgrades","items":{"type":"object"},"nullable":true,"type":"array"},"version_series":{"description":"Version series this deployment is locked to (e.g. \"0.1\")","nullable":true,"type":"string"}},"type":"object"},"workflow_reports":{"description":"Reports from workflow executions","nullable":true,"type":"object"}},"required":["instance_id","redis_db","status","online_check_counter","inserted_at"],"type":"object"}}}}
```

## The UtilitiesWorkflowEvent object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"UtilitiesWorkflowEvent":{"properties":{"status":{"description":"Event status","type":"string"},"timestamp":{"description":"Event timestamp","format":"date-time","type":"string"}},"required":["status","timestamp"],"type":"object"}}}}
```

## The UtilitiesBlobPublicInfo object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"UtilitiesBlobPublicInfo":{"properties":{"content_type":{"description":"file content type","type":"string"},"filename":{"description":"file name","type":"string"},"key":{"description":"the key under which the file will be stored in the cloud","type":"string"},"read_url":{"description":"the URL to which a client can upload a file. The upload is done via `PUT` and there should be header `x-ms-blob-type: BlockBlob`","format":"uri","type":"string"},"storage_backend_name":{"description":"name of the cloud storage configuration","type":"string"},"storage_backend_type":{"description":"which cloud provider the file is stored in","type":"string"},"uploaded":{"description":"","type":"boolean"}},"required":["key","filename","content_type","uploaded","storage_backend_name","storage_backend_type"],"type":"object"}}}}
```

## The UtilitiesComponent object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"UtilitiesComponent":{"properties":{"api_version":{"description":"API version","type":"string"},"git_commit":{"description":"Git commit hash","type":"string"},"name":{"description":"API name","type":"string"}},"required":["name","api_version","git_commit"],"type":"object"}}}}
```

## The UtilitiesBlobInfo object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"UtilitiesBlobInfo":{"properties":{"content_type":{"description":"file content type","type":"string"},"filename":{"description":"file name","type":"string"},"key":{"description":"the key under which the file will be stored in the cloud","type":"string"},"read_url":{"description":"the URL to which a client can upload a file. The upload is done via `PUT` and there should be header `x-ms-blob-type: BlockBlob`","format":"uri","type":"string"},"storage_backend_name":{"description":"name of the cloud storage configuration","type":"string"},"storage_backend_type":{"description":"which cloud provider the file is histed at","type":"string"},"upload_headers":{"description":"HTTP headers which must be added to the HTTP upload call","type":"object"},"upload_url":{"description":"the URL to which a client can upload a file. The upload is done via `PUT` and there should be header `x-ms-blob-type: BlockBlob`","format":"uri","type":"string"},"upload_url_expires_in_seconds":{"description":"seconds during which the upload URL is valid","type":"integer"},"uploaded":{"description":"","type":"boolean"}},"required":["key","filename","content_type","uploaded","storage_backend_name","storage_backend_type"],"type":"object"}}}}
```

## The UtilitiesApplicationVersion object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"UtilitiesApplicationVersion":{"properties":{"component":{"$ref":"#/components/schemas/UtilitiesComponent"}},"required":["component"],"type":"object"},"UtilitiesComponent":{"properties":{"api_version":{"description":"API version","type":"string"},"git_commit":{"description":"Git commit hash","type":"string"},"name":{"description":"API name","type":"string"}},"required":["name","api_version","git_commit"],"type":"object"}}}}
```

## The UtilitiesBlobPublicInfoResponse object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"UtilitiesBlobPublicInfoResponse":{"properties":{"blob":{"$ref":"#/components/schemas/UtilitiesBlobPublicInfo"}},"required":["blob"],"type":"object"},"UtilitiesBlobPublicInfo":{"properties":{"content_type":{"description":"file content type","type":"string"},"filename":{"description":"file name","type":"string"},"key":{"description":"the key under which the file will be stored in the cloud","type":"string"},"read_url":{"description":"the URL to which a client can upload a file. The upload is done via `PUT` and there should be header `x-ms-blob-type: BlockBlob`","format":"uri","type":"string"},"storage_backend_name":{"description":"name of the cloud storage configuration","type":"string"},"storage_backend_type":{"description":"which cloud provider the file is stored in","type":"string"},"uploaded":{"description":"","type":"boolean"}},"required":["key","filename","content_type","uploaded","storage_backend_name","storage_backend_type"],"type":"object"}}}}
```

## The UtilitiesPaginatedDeployments object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"UtilitiesPaginatedDeployments":{"properties":{"deployments":{"items":{"$ref":"#/components/schemas/UtilitiesDeployment"},"type":"array"},"meta":{"$ref":"#/components/schemas/UtilitiesPaginationMeta"}},"required":["meta","deployments"],"type":"object"},"UtilitiesDeployment":{"properties":{"all_workflows_successful":{"description":"Whether all workflows completed successfully","nullable":true,"type":"boolean"},"current_user_id":{"description":"Current user ID","format":"uuid","nullable":true,"type":"string"},"db_name":{"description":"PostgreSQL database name for the SVX Wallet instance","nullable":true,"type":"string"},"description":{"description":"Optional human-readable description for this SVX Wallet instance","nullable":true,"type":"string"},"error":{"description":"Error message","nullable":true,"type":"string"},"external_idp_client_id":{"description":"External IdP client ID","nullable":true,"type":"string"},"git_workflow":{"description":"Git workflow status","nullable":true,"type":"string"},"git_workflow_duration":{"description":"Git workflow duration in milliseconds","nullable":true,"type":"integer"},"inserted_at":{"description":"Creation timestamp","format":"date-time","type":"string"},"instance_config_for_workflow_retries":{"description":"Config data for workflow retries","nullable":true,"type":"object"},"instance_id":{"description":"SVX Wallet instance ID","type":"string"},"internal_domain":{"description":"Internal domain for the deployment","nullable":true,"type":"string"},"online_at":{"description":"Timestamp when deployment went online","format":"date-time","nullable":true,"type":"string"},"online_check_counter":{"default":0,"description":"Counter for online status checks","type":"integer"},"online_status_checked_at":{"description":"Timestamp when online status was last checked","format":"date-time","nullable":true,"type":"string"},"org_id":{"description":"Organisation ID","nullable":true,"type":"string"},"org_name":{"description":"Organisation name","nullable":true,"type":"string"},"public_domain":{"description":"Public domain URL for the deployment","nullable":true,"type":"string"},"redis_db":{"description":"Redis database number","type":"integer"},"status":{"description":"Current deployment status","type":"string"},"tenant_id":{"description":"Tenant ID","nullable":true,"type":"string"},"tenant_name":{"description":"Tenant name","nullable":true,"type":"string"},"versions":{"description":"Version information for this deployment","nullable":true,"properties":{"deployed_version":{"description":"Full semver of the currently deployed version (e.g. \"0.1.0\")","nullable":true,"type":"string"},"version_history":{"description":"History of deployed versions and upgrades","items":{"type":"object"},"nullable":true,"type":"array"},"version_series":{"description":"Version series this deployment is locked to (e.g. \"0.1\")","nullable":true,"type":"string"}},"type":"object"},"workflow_reports":{"description":"Reports from workflow executions","nullable":true,"type":"object"}},"required":["instance_id","redis_db","status","online_check_counter","inserted_at"],"type":"object"},"UtilitiesPaginationMeta":{"properties":{"order":{"description":"Order direcction: desc or asc","type":"string"},"order_by":{"description":"Field by which ordering is done","type":"string"},"order_from_params":{"description":"Defines whether the ordering direction is taken from request parameters or is the default value","type":"boolean"},"page":{"description":"Page number","type":"integer"},"page_count":{"description":"Total number of pages","type":"integer"},"per_page":{"description":"Records per page","type":"integer"},"per_page_from_params":{"description":"Defines whether the the number of recors is taken from request parameters or is the default value","type":"boolean"},"records_count":{"description":"Total number of metrics","type":"integer"}},"required":["order","order_by","order_from_params","page","page_count","per_page","per_page_from_params","records_count"],"type":"object"}}}}
```

## The ATOMUser object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMUser":{"properties":{"archived":{"nullable":false,"type":"boolean"},"email":{"description":"user email","nullable":true,"type":"string"},"family_name":{"description":"user family name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"given_name":{"description":"user given name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"id":{"description":"User ID","format":"uuid","type":"string"}},"required":["id"],"type":"object"}}}}
```

## The ATOMSecurityRightsOfUser object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMSecurityRightsOfUser":{"properties":{"orgs":{"description":"Names and IDs of organizations referenced in `security_rights`.","items":{"$ref":"#/components/schemas/ATOMOrgDescription"},"type":"array"},"security_rights":{"description":"Security rights assigned to the user","items":{"$ref":"#/components/schemas/ATOMSecurityRightsGroup"},"type":"array"},"tenants":{"description":"Names and IDs of tenants referenced in `security_rights`.","items":{"$ref":"#/components/schemas/ATOMTenantDescription"},"type":"array"}},"required":["security_rights","tenants","orgs"],"type":"object"},"ATOMOrgDescription":{"properties":{"id":{"description":"ID of an organisation","type":"string"},"name":{"description":"Name of an organisation","type":"string"}},"required":["id","name"],"type":"object"},"ATOMSecurityRightsGroup":{"properties":{"scope":{"$ref":"#/components/schemas/ATOMSecurityRightGroupSpec"},"security_rights":{"description":"list of all security rights","items":{"type":"string"},"type":"array"}},"required":["scope","security_rights"],"type":"object"},"ATOMSecurityRightGroupSpec":{"properties":{"org_id":{"description":"ID of an organisation","nullable":true,"type":"string"},"tenant_id":{"description":"ID of a tenant","nullable":true,"type":"string"}},"required":["tenant_id","org_id"],"type":"object"},"ATOMTenantDescription":{"properties":{"id":{"description":"ID of a tenant","type":"string"},"name":{"description":"Name of a tenant","type":"string"}},"required":["id","name"],"type":"object"}}}}
```

## The ATOMPaginatedAdminList object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMPaginatedAdminList":{"properties":{"admins":{"description":"List of users","items":{"$ref":"#/components/schemas/ATOMUser"},"type":"array"},"meta":{"$ref":"#/components/schemas/ATOMMeta"},"next_page_after":{"description":"A value which allows to retrieve the next page. (Cursor-based pagination)","nullable":true,"type":"string"}},"required":["admins"],"type":"object"},"ATOMUser":{"properties":{"archived":{"nullable":false,"type":"boolean"},"email":{"description":"user email","nullable":true,"type":"string"},"family_name":{"description":"user family name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"given_name":{"description":"user given name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"id":{"description":"User ID","format":"uuid","type":"string"}},"required":["id"],"type":"object"},"ATOMMeta":{"properties":{},"type":"object"}}}}
```

## The ATOMTenant object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMTenant":{"properties":{"archived":{"format":"uuid","type":"boolean"},"authorised_officer_email":{"description":"Authorised officer email","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"business_address":{"description":"Business address","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"color":{"description":"The color associated with the tenant. Used for the UI.","maxLength":20,"minLength":0,"nullable":true,"type":"string"},"company_number":{"description":"Company number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Tenant ID","format":"uuid","type":"string"},"legal_name":{"description":"Legal number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"lei_number":{"description":"Legal entity identification number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","nullable":true,"type":"string"},"name":{"description":"Tenant name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the tenant","items":{"type":"string"},"type":"array"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","security_rights"],"type":"object"}}}}
```

## The ATOMSecurityRights object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMSecurityRights":{"properties":{"security_rights":{"description":"list of security rights","items":{"type":"string"},"type":"array"}},"required":["security_rights"],"type":"object"}}}}
```

## The ATOMTenantInJwtForWhoAmI object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMTenantInJwtForWhoAmI":{"properties":{"tenant_id":{"description":"Tenant ID","format":"uuid","nullable":true,"type":"string"},"tenant_known_to_atom":{"description":"Whether the tenant is registered in ATOM","nullable":true,"type":"boolean"},"tenant_name":{"description":"Tenant name","nullable":true,"type":"string"},"user_became_tenant_admin_at":{"description":"When the user became an admin of the tenant","format":"date-time","nullable":true,"type":"string"}},"required":["tenant_name","tenant_id","tenant_known_to_atom","user_became_tenant_admin_at"],"type":"object"}}}}
```

## The ATOMSecurityRightSpecInRegistry object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMSecurityRightSpecInRegistry":{"properties":{"active":{"description":"Whether the security right is actively used","type":"boolean"},"assigned_by_default":{"description":"Whether the security right should be assigned by default","type":"boolean"},"description":{"description":"Description of the security right","type":"string"},"for_org":{"description":"Whether the security right can only assigned to a user for a specific organisation","type":"boolean"},"for_tenant":{"description":"Whether the security right can only assigned to a user for a specific tenant","type":"boolean"},"internal_atom_security_right":{"description":"Whether the security right is an internal ATOM securuty right","type":"boolean"}},"required":["description","for_org","for_tenant","internal_atom_security_right","active","assigned_by_default"],"type":"object"}}}}
```

## The ATOMAssignSecurityRightsRequest object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMAssignSecurityRightsRequest":{"properties":{"security_rights":{"description":"list of security rights","items":{"type":"string"},"type":"array"}},"required":["security_rights"],"type":"object"}}}}
```

## The ATOMCreateOrUpdateOrgRequest object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMCreateOrUpdateOrgRequest":{"properties":{"authorised_officer_email":{"description":"Authorised officer email","type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","type":"string"},"business_address":{"description":"Business address","type":"string"},"color":{"description":"The color associated with the organisation in the hex format. Used for the UI.","type":"string"},"company_number":{"description":"Company number","type":"string"},"company_url":{"description":"URL of the company","format":"uri","nullable":true,"type":"string"},"legal_name":{"description":"Legal number","type":"string"},"lei_number":{"description":"Legal entity identification number","type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","type":"string"},"name":{"description":"Name of the organisation to create","type":"string"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","type":"string"},"trading_name":{"description":"Trading number","type":"string"}},"required":["name"],"type":"object"}}}}
```

## The ATOMSecurityRightsRegistry object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMSecurityRightsRegistry":{"properties":{"security_rights":{"description":"security rights known to ATOM","items":{"$ref":"#/components/schemas/ATOMSecurityRightInRegistry"},"type":"array"}},"required":["security_rights"],"type":"object"},"ATOMSecurityRightInRegistry":{"properties":{"security_right":{"description":"security right","type":"string"},"spec":{"$ref":"#/components/schemas/ATOMSecurityRightSpecInRegistry"}},"required":["security_right","spec"],"type":"object"},"ATOMSecurityRightSpecInRegistry":{"properties":{"active":{"description":"Whether the security right is actively used","type":"boolean"},"assigned_by_default":{"description":"Whether the security right should be assigned by default","type":"boolean"},"description":{"description":"Description of the security right","type":"string"},"for_org":{"description":"Whether the security right can only assigned to a user for a specific organisation","type":"boolean"},"for_tenant":{"description":"Whether the security right can only assigned to a user for a specific tenant","type":"boolean"},"internal_atom_security_right":{"description":"Whether the security right is an internal ATOM securuty right","type":"boolean"}},"required":["description","for_org","for_tenant","internal_atom_security_right","active","assigned_by_default"],"type":"object"}}}}
```

## The ATOMError object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","args","http_code","message","file","line"],"type":"object"}}}}
```

## The ATOMPaginatedTenantList object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMPaginatedTenantList":{"properties":{"meta":{"$ref":"#/components/schemas/ATOMMeta"},"next_page_after":{"description":"A value which allows to retrieve the next page. (Cursor-based pagination)","nullable":true,"type":"string"},"tenants":{"description":"List of tenants","items":{"$ref":"#/components/schemas/ATOMTenant"},"type":"array"}},"required":["tenants"],"type":"object"},"ATOMMeta":{"properties":{},"type":"object"},"ATOMTenant":{"properties":{"archived":{"format":"uuid","type":"boolean"},"authorised_officer_email":{"description":"Authorised officer email","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"business_address":{"description":"Business address","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"color":{"description":"The color associated with the tenant. Used for the UI.","maxLength":20,"minLength":0,"nullable":true,"type":"string"},"company_number":{"description":"Company number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Tenant ID","format":"uuid","type":"string"},"legal_name":{"description":"Legal number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"lei_number":{"description":"Legal entity identification number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","nullable":true,"type":"string"},"name":{"description":"Tenant name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the tenant","items":{"type":"string"},"type":"array"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","security_rights"],"type":"object"}}}}
```

## The ATOMOrg object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMOrg":{"properties":{"archived":{"format":"uuid","type":"boolean"},"authorised_officer_email":{"description":"Authorised officer email","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"business_address":{"description":"Business address","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"color":{"description":"The color associated with the tenant. Used for the UI.","maxLength":20,"minLength":0,"nullable":true,"type":"string"},"company_number":{"description":"Company number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"company_url":{"description":"URL of the company","format":"uri","nullable":true,"type":"string"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Organisation ID","format":"uuid","type":"string"},"legal_name":{"description":"Legal number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"lei_number":{"description":"Legal entity identification number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","nullable":true,"type":"string"},"name":{"description":"Organisation name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the organisation","items":{"type":"string"},"type":"array"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"tenant_id":{"description":"Tenant ID","format":"uuid","type":"string"},"tenant_name":{"description":"Tenant name","minLength":1,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","tenant_id"],"type":"object"}}}}
```

## The ATOMTenantIdAndName object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMTenantIdAndName":{"properties":{"color":{"description":"The color associated with the tenant. Used for the UI.","type":"string"},"id":{"description":"ID of a tenant","type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","type":"string"},"name":{"description":"Name of the tenant","type":"string"}},"required":["id","name","logo_url","color"],"type":"object"}}}}
```

## The ATOMMeta object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMMeta":{"properties":{},"type":"object"}}}}
```

## The ATOMSecurityRightInRegistry object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMSecurityRightInRegistry":{"properties":{"security_right":{"description":"security right","type":"string"},"spec":{"$ref":"#/components/schemas/ATOMSecurityRightSpecInRegistry"}},"required":["security_right","spec"],"type":"object"},"ATOMSecurityRightSpecInRegistry":{"properties":{"active":{"description":"Whether the security right is actively used","type":"boolean"},"assigned_by_default":{"description":"Whether the security right should be assigned by default","type":"boolean"},"description":{"description":"Description of the security right","type":"string"},"for_org":{"description":"Whether the security right can only assigned to a user for a specific organisation","type":"boolean"},"for_tenant":{"description":"Whether the security right can only assigned to a user for a specific tenant","type":"boolean"},"internal_atom_security_right":{"description":"Whether the security right is an internal ATOM securuty right","type":"boolean"}},"required":["description","for_org","for_tenant","internal_atom_security_right","active","assigned_by_default"],"type":"object"}}}}
```

## The ATOMActiveAndArchivedOrgList object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMActiveAndArchivedOrgList":{"properties":{"archived_orgs":{"description":"List of archived orgs","items":{"$ref":"#/components/schemas/ATOMOrg"},"type":"array"},"orgs":{"description":"List of active orgs","items":{"$ref":"#/components/schemas/ATOMOrg"},"type":"array"}},"required":["orgs"],"type":"object"},"ATOMOrg":{"properties":{"archived":{"format":"uuid","type":"boolean"},"authorised_officer_email":{"description":"Authorised officer email","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"business_address":{"description":"Business address","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"color":{"description":"The color associated with the tenant. Used for the UI.","maxLength":20,"minLength":0,"nullable":true,"type":"string"},"company_number":{"description":"Company number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"company_url":{"description":"URL of the company","format":"uri","nullable":true,"type":"string"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Organisation ID","format":"uuid","type":"string"},"legal_name":{"description":"Legal number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"lei_number":{"description":"Legal entity identification number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","nullable":true,"type":"string"},"name":{"description":"Organisation name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the organisation","items":{"type":"string"},"type":"array"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"tenant_id":{"description":"Tenant ID","format":"uuid","type":"string"},"tenant_name":{"description":"Tenant name","minLength":1,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","tenant_id"],"type":"object"}}}}
```

## The ATOMSecurityRightsGroup object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMSecurityRightsGroup":{"properties":{"scope":{"$ref":"#/components/schemas/ATOMSecurityRightGroupSpec"},"security_rights":{"description":"list of all security rights","items":{"type":"string"},"type":"array"}},"required":["scope","security_rights"],"type":"object"},"ATOMSecurityRightGroupSpec":{"properties":{"org_id":{"description":"ID of an organisation","nullable":true,"type":"string"},"tenant_id":{"description":"ID of a tenant","nullable":true,"type":"string"}},"required":["tenant_id","org_id"],"type":"object"}}}}
```

## The ATOMComponent object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMComponent":{"properties":{"api_version":{"description":"API version","type":"string"},"git_commit":{"description":"Git commit hash","type":"string"},"name":{"description":"API name","type":"string"}},"required":["name","api_version","git_commit"],"type":"object"}}}}
```

## The ATOMAdministeredOrg object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMAdministeredOrg":{"properties":{"color":{"description":"The color associated with the tenant. Used for the UI.","type":"string"},"id":{"description":"ID of an organisation","type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","type":"string"},"name":{"description":"Name of the organisation","type":"string"},"tenant_active":{"type":"boolean"},"tenant_id":{"description":"ID of the tenant of the organisation","type":"string"},"user_became_org_admin_at":{"description":"When the user became an admin of the organisation","format":"date-time","type":"string"}},"required":["id","name","tenant_id","logo_url","color"],"type":"object"}}}}
```

## The ATOMOneTenant object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMOneTenant":{"properties":{"tenant":{"$ref":"#/components/schemas/ATOMTenant"}},"required":["tenant"],"type":"object"},"ATOMTenant":{"properties":{"archived":{"format":"uuid","type":"boolean"},"authorised_officer_email":{"description":"Authorised officer email","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"business_address":{"description":"Business address","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"color":{"description":"The color associated with the tenant. Used for the UI.","maxLength":20,"minLength":0,"nullable":true,"type":"string"},"company_number":{"description":"Company number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Tenant ID","format":"uuid","type":"string"},"legal_name":{"description":"Legal number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"lei_number":{"description":"Legal entity identification number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","nullable":true,"type":"string"},"name":{"description":"Tenant name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the tenant","items":{"type":"string"},"type":"array"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","security_rights"],"type":"object"}}}}
```

## The ATOMSecurityRightGroupSpec object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMSecurityRightGroupSpec":{"properties":{"org_id":{"description":"ID of an organisation","nullable":true,"type":"string"},"tenant_id":{"description":"ID of a tenant","nullable":true,"type":"string"}},"required":["tenant_id","org_id"],"type":"object"}}}}
```

## The ATOMTenantDescription object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMTenantDescription":{"properties":{"id":{"description":"ID of a tenant","type":"string"},"name":{"description":"Name of a tenant","type":"string"}},"required":["id","name"],"type":"object"}}}}
```

## The ATOMAdministeredArchivedOrg object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMAdministeredArchivedOrg":{"properties":{"color":{"description":"The color associated with the tenant. Used for the UI.","type":"string"},"id":{"description":"ID of an organisation","type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","type":"string"},"name":{"description":"Name of the organisation","type":"string"},"tenant_active":{"type":"boolean"},"tenant_id":{"description":"ID of the tenant of the organisation","type":"string"}},"required":["id","name","tenant_id","logo_url","color"],"type":"object"}}}}
```

## The ATOMOrgDescription object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMOrgDescription":{"properties":{"id":{"description":"ID of an organisation","type":"string"},"name":{"description":"Name of an organisation","type":"string"}},"required":["id","name"],"type":"object"}}}}
```

## The ATOMCreateOrUpdateTenantRequest object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMCreateOrUpdateTenantRequest":{"properties":{"authorised_officer_email":{"description":"Authorised officer email","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"business_address":{"description":"Business address","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"color":{"description":"The color associated with the tenant. Used for the UI.","maxLength":20,"minLength":0,"nullable":true,"type":"string"},"company_number":{"description":"Company number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"id":{"description":"ID of the tenant. This parameter is optional. If missing, ATOM will choose a random UUID","format":"uuid","type":"string"},"legal_name":{"description":"Legal number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"lei_number":{"description":"Legal entity identification number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","nullable":true,"type":"string"},"name":{"description":"Name of the tenant","type":"string"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["name"],"type":"object"}}}}
```

## The ATOMOneOrg object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMOneOrg":{"properties":{"org":{"$ref":"#/components/schemas/ATOMOrg"}},"required":["org"],"type":"object"},"ATOMOrg":{"properties":{"archived":{"format":"uuid","type":"boolean"},"authorised_officer_email":{"description":"Authorised officer email","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"business_address":{"description":"Business address","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"color":{"description":"The color associated with the tenant. Used for the UI.","maxLength":20,"minLength":0,"nullable":true,"type":"string"},"company_number":{"description":"Company number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"company_url":{"description":"URL of the company","format":"uri","nullable":true,"type":"string"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Organisation ID","format":"uuid","type":"string"},"legal_name":{"description":"Legal number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"lei_number":{"description":"Legal entity identification number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","nullable":true,"type":"string"},"name":{"description":"Organisation name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the organisation","items":{"type":"string"},"type":"array"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"tenant_id":{"description":"Tenant ID","format":"uuid","type":"string"},"tenant_name":{"description":"Tenant name","minLength":1,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","tenant_id"],"type":"object"}}}}
```

## The ATOMPaginatedOrgList object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMPaginatedOrgList":{"properties":{"meta":{"$ref":"#/components/schemas/ATOMMeta"},"next_page_after":{"description":"A value which allows to retrieve the next page. (Cursor-based pagination)","nullable":true,"type":"string"},"orgs":{"description":"List of orgs","items":{"$ref":"#/components/schemas/ATOMOrg"},"type":"array"}},"required":["orgs"],"type":"object"},"ATOMMeta":{"properties":{},"type":"object"},"ATOMOrg":{"properties":{"archived":{"format":"uuid","type":"boolean"},"authorised_officer_email":{"description":"Authorised officer email","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"business_address":{"description":"Business address","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"color":{"description":"The color associated with the tenant. Used for the UI.","maxLength":20,"minLength":0,"nullable":true,"type":"string"},"company_number":{"description":"Company number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"company_url":{"description":"URL of the company","format":"uri","nullable":true,"type":"string"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Organisation ID","format":"uuid","type":"string"},"legal_name":{"description":"Legal number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"lei_number":{"description":"Legal entity identification number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","nullable":true,"type":"string"},"name":{"description":"Organisation name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the organisation","items":{"type":"string"},"type":"array"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"tenant_id":{"description":"Tenant ID","format":"uuid","type":"string"},"tenant_name":{"description":"Tenant name","minLength":1,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","tenant_id"],"type":"object"}}}}
```

## The ATOMWhoAmI object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMWhoAmI":{"properties":{"administered_archived_orgs":{"description":"Names and IDs of the archived organizations the user administered","items":{"$ref":"#/components/schemas/ATOMAdministeredArchivedOrg"},"type":"array"},"administered_archived_tenants":{"description":"Names and IDs of the archived tenants the user administered","items":{"$ref":"#/components/schemas/ATOMTenantIdAndName"},"type":"array"},"administered_orgs":{"description":"Names and IDs of the organizations the user administers","items":{"$ref":"#/components/schemas/ATOMAdministeredOrg"},"type":"array"},"administered_tenants":{"description":"Names and IDs of the tenants the user administers","items":{"$ref":"#/components/schemas/ATOMTenantIdAndName"},"type":"array"},"family_name":{"description":"User family name","nullable":true,"type":"string"},"given_name":{"description":"User given name","nullable":true,"type":"string"},"id":{"description":"User ID from the JWT (taken from `sub`)","format":"uuid","type":"string"},"tenant_in_jwt":{"$ref":"#/components/schemas/ATOMTenantInJwtForWhoAmI"},"user_known_to_atom":{"description":"Whether the user is known to ATOM","type":"boolean"},"user_type":{"description":"user, tenant-agent, or org-agent","nullable":true,"type":"string"}},"required":["id","user_known_to_atom","user_type","family_name","given_name","tenant_in_jwt","administered_orgs","administered_tenants"],"type":"object"},"ATOMAdministeredArchivedOrg":{"properties":{"color":{"description":"The color associated with the tenant. Used for the UI.","type":"string"},"id":{"description":"ID of an organisation","type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","type":"string"},"name":{"description":"Name of the organisation","type":"string"},"tenant_active":{"type":"boolean"},"tenant_id":{"description":"ID of the tenant of the organisation","type":"string"}},"required":["id","name","tenant_id","logo_url","color"],"type":"object"},"ATOMTenantIdAndName":{"properties":{"color":{"description":"The color associated with the tenant. Used for the UI.","type":"string"},"id":{"description":"ID of a tenant","type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","type":"string"},"name":{"description":"Name of the tenant","type":"string"}},"required":["id","name","logo_url","color"],"type":"object"},"ATOMAdministeredOrg":{"properties":{"color":{"description":"The color associated with the tenant. Used for the UI.","type":"string"},"id":{"description":"ID of an organisation","type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","type":"string"},"name":{"description":"Name of the organisation","type":"string"},"tenant_active":{"type":"boolean"},"tenant_id":{"description":"ID of the tenant of the organisation","type":"string"},"user_became_org_admin_at":{"description":"When the user became an admin of the organisation","format":"date-time","type":"string"}},"required":["id","name","tenant_id","logo_url","color"],"type":"object"},"ATOMTenantInJwtForWhoAmI":{"properties":{"tenant_id":{"description":"Tenant ID","format":"uuid","nullable":true,"type":"string"},"tenant_known_to_atom":{"description":"Whether the tenant is registered in ATOM","nullable":true,"type":"boolean"},"tenant_name":{"description":"Tenant name","nullable":true,"type":"string"},"user_became_tenant_admin_at":{"description":"When the user became an admin of the tenant","format":"date-time","nullable":true,"type":"string"}},"required":["tenant_name","tenant_id","tenant_known_to_atom","user_became_tenant_admin_at"],"type":"object"}}}}
```

## The ATOMAdmin object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMAdmin":{"properties":{"admin":{"$ref":"#/components/schemas/ATOMUser"}},"required":["admin"],"type":"object"},"ATOMUser":{"properties":{"archived":{"nullable":false,"type":"boolean"},"email":{"description":"user email","nullable":true,"type":"string"},"family_name":{"description":"user family name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"given_name":{"description":"user given name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"id":{"description":"User ID","format":"uuid","type":"string"}},"required":["id"],"type":"object"}}}}
```

## The ATOMApplicationVersion object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMApplicationVersion":{"properties":{"component":{"$ref":"#/components/schemas/ATOMComponent"}},"required":["component"],"type":"object"},"ATOMComponent":{"properties":{"api_version":{"description":"API version","type":"string"},"git_commit":{"description":"Git commit hash","type":"string"},"name":{"description":"API name","type":"string"}},"required":["name","api_version","git_commit"],"type":"object"}}}}
```

## The ATOMOrgList object

```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"components":{"schemas":{"ATOMOrgList":{"properties":{"orgs":{"description":"List of orgs","items":{"$ref":"#/components/schemas/ATOMOrg"},"type":"array"}},"required":["orgs"],"type":"object"},"ATOMOrg":{"properties":{"archived":{"format":"uuid","type":"boolean"},"authorised_officer_email":{"description":"Authorised officer email","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"business_address":{"description":"Business address","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"color":{"description":"The color associated with the tenant. Used for the UI.","maxLength":20,"minLength":0,"nullable":true,"type":"string"},"company_number":{"description":"Company number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"company_url":{"description":"URL of the company","format":"uri","nullable":true,"type":"string"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Organisation ID","format":"uuid","type":"string"},"legal_name":{"description":"Legal number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"lei_number":{"description":"Legal entity identification number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","nullable":true,"type":"string"},"name":{"description":"Organisation name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the organisation","items":{"type":"string"},"type":"array"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"tenant_id":{"description":"Tenant ID","format":"uuid","type":"string"},"tenant_name":{"description":"Tenant name","minLength":1,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","tenant_id"],"type":"object"}}}}
```