{
"openapi": "3.0.1",
"info": {
"title": "Fenergo Nebula Digital IDV Command",
"description": "**Digital IDV Command API**:
Digital IDV Command API provides endpoints in order to manage all inscope entities.
**Digital IDV Command API provides**:
- Entity Digital IDV Management
",
"version": "1.0"
},
"servers": [
{
"url": "/digitalidvcommand"
}
],
"paths": {
"/api/configuration/provider/{providerId}/status": {
"put": {
"tags": [
"Configuration"
],
"summary": "Save Provider status",
"description": "
Required permissions:
Following permissions are required: DigitalIdvConfiguration",
"operationId": "SaveProviderStatus",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BooleanServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BooleanServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BooleanServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Accepted"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/configuration/provider/{providerId}/configuration": {
"put": {
"tags": [
"Configuration"
],
"summary": "Save Configuration",
"description": "
Required permissions:
Following permissions are required: DigitalIdvConfiguration",
"operationId": "SaveProviderConfiguration",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ProviderConfigurationDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ProviderConfigurationDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ProviderConfigurationDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Provider added",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SaveProviderConfigurationResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SaveProviderConfigurationResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SaveProviderConfigurationResponseDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/entity-in-scope": {
"post": {
"tags": [
"EntityInScopeForIdv"
],
"summary": "Creates an Entity in Scope for Idv.",
"description": "
Required permissions:
Following permissions are required: IdvEdit",
"operationId": "CreateEntityInScopeForIdv",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "The request.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EntityInScopeForIdvRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EntityInScopeForIdvRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EntityInScopeForIdvRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "EntityInScopeForIdvDto model created successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EntityInScopeForIdvResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityInScopeForIdvResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EntityInScopeForIdvResponseDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/entity-in-scope/{id}": {
"put": {
"tags": [
"EntityInScopeForIdv"
],
"summary": "Updates the Entity in Scope for Idv.",
"description": "
Required permissions:
Following permissions are required: IdvEdit",
"operationId": "UpdateEntityInScopeForIdv",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The identifier.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "The status.",
"content": {
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
},
"application/*+json": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"202": {
"description": "EntityInScopeForIdvDto model updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UpdateEntityInScopeForIdvResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEntityInScopeForIdvResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEntityInScopeForIdvResponseDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. No Entity In Scope was found for the Id provided",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server error"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
},
"delete": {
"tags": [
"EntityInScopeForIdv"
],
"summary": "Deletes the Entity in Scope for Idv.",
"description": "
Required permissions:
Following permissions are required: IdvDelete",
"operationId": "DeleteEntityInScopeForIdv",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The identifier.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"202": {
"description": "EntityInScopeForIdvDto model deleted successfully"
},
"400": {
"description": "Bad Request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. No Entity In Scope was found for the Id provided",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server error"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/entity-in-scope/evaluate-create-idv-status": {
"post": {
"tags": [
"EntityInScopeForIdv"
],
"summary": "Evaluate and create IDV model for an entity",
"description": "\n - Evaluates an entity's data and documents against their policy requirements
\n - Creates the aggregate model and returns an IDV compliance status
\n
Required permissions:
Following permissions are required: IdvEdit",
"operationId": "EvaluateCreateIdvStatus",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "Service request containing a Fenergo.Nebula.DigitalIDV.IDVComplianceEngine.Application.Dto.EvaluateIdvStatusRequestDto with IDs required for evaluation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EvaluateIdvStatusRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EvaluateIdvStatusRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EvaluateIdvStatusRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "IDV model successfully evaluated and created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EvaluateAndSetIdvStatusResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluateAndSetIdvStatusResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EvaluateAndSetIdvStatusResponseDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/entity-in-scope/evaluate-update-idv-status/{id}": {
"put": {
"tags": [
"EntityInScopeForIdv"
],
"summary": "Evaluate and update IDV model for an entity",
"description": "\n - Evaluates an entity's data and documents against their policy requirements
\n - Updates the aggregate model and returns an IDV compliance status
\n
Required permissions:
Following permissions are required: IdvEdit",
"operationId": "EvaluateUpdateIdvStatus",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The identifier",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "Service request containing a Fenergo.Nebula.DigitalIDV.IDVComplianceEngine.Application.Dto.EvaluateIdvStatusRequestDto with IDs required for evaluation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EvaluateIdvStatusRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EvaluateIdvStatusRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/EvaluateIdvStatusRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "IDV model successfully evaluated and created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EvaluateAndSetIdvStatusResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluateAndSetIdvStatusResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EvaluateAndSetIdvStatusResponseDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/idv-business-process": {
"post": {
"tags": [
"IdvBusinessProcess"
],
"summary": "Initiate an Idv requirements validation business process.",
"description": "\nIdv requirements validation business process initialization
Required permissions:
Following permissions are required: IdvAccess",
"operationId": "InitiateIdvRequirementsValidation",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "ServiceRequest with the Fenergo.Nebula.DigitalIDV.Command.Application.Dto.IdvRequirementsValidation.InitiateIdvRequirementsValidationDto to initiate business process",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InitiateIdvRequirementsValidationDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InitiateIdvRequirementsValidationDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InitiateIdvRequirementsValidationDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Idv requirements validation business process initiated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/InitiateIdvRequirementsValidationResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InitiateIdvRequirementsValidationResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/InitiateIdvRequirementsValidationResponseDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "Internal server error"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/IdvConfiguration/create/configuration": {
"post": {
"tags": [
"IdvConfiguration"
],
"summary": "Creates a new Idv Configuration with a first draft version.",
"description": "
Required permissions:
Following permissions are required: DigitalIdvConfiguration",
"operationId": "CreateIdvConfiguration",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/IdvNewConfigurationDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/IdvNewConfigurationDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/IdvNewConfigurationDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"200": {
"description": "Idv draft configuration created successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/IdvConfiguration/create/draft": {
"post": {
"tags": [
"IdvConfiguration"
],
"summary": "Create Draft Idv Configuration",
"description": "
Required permissions:
Following permissions are required: DigitalIdvConfiguration",
"operationId": "CreateDraftIdvConfiguration",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateDraftIdvConfigurationDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateDraftIdvConfigurationDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateDraftIdvConfigurationDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"200": {
"description": "Idv draft configuration created successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/IdvConfiguration/update/draft": {
"put": {
"tags": [
"IdvConfiguration"
],
"summary": "Update Idv Configuration",
"description": "
Required permissions:
Following permissions are required: DigitalIdvConfiguration",
"operationId": "UpdateDraftIdvConfiguration",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/IdvConfigurationDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/IdvConfigurationDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/IdvConfigurationDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"200": {
"description": "Idv draft configuration updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/IdvConfiguration/delete/draft": {
"post": {
"tags": [
"IdvConfiguration"
],
"summary": "Delete Idv Configuration",
"description": "
Required permissions:
Following permissions are required: DigitalIdvConfiguration",
"operationId": "DeleteDraftIdvConfiguration",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GuidServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GuidServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GuidServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"200": {
"description": "Idv draft configuration deleted successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/BooleanServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BooleanServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/IdvConfiguration/publish": {
"post": {
"tags": [
"IdvConfiguration"
],
"summary": "Publish Idv Configuration",
"description": "
Required permissions:
Following permissions are required: DigitalIdvConfiguration",
"operationId": "PublishDraftIdvConfiguration",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GuidServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GuidServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GuidServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"200": {
"description": "Idv draft configuration published successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/BooleanServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BooleanServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BooleanServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/IdvConfiguration/archive": {
"post": {
"tags": [
"IdvConfiguration"
],
"summary": "Archive Idv Configuration",
"description": "
Required permissions:
Following permissions are required: DigitalIdvConfiguration",
"operationId": "ArchivePublishedIdvConfiguration",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/IdvConfigurationDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/IdvConfigurationDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/IdvConfigurationDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"200": {
"description": "Idv published configuration archived successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/idv-requirement-status": {
"post": {
"tags": [
"IdvRequirementStatus"
],
"summary": "Create new Idv Requirement Status Model",
"description": "\nThis method will create a new Idv Requirement Status Model\n The new model will initialize with the DTO data.
Required permissions:
Following permissions are required: IdvEdit",
"operationId": "CreateIdvRequirementStatusModel",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "ServiceRequest with the Fenergo.Nebula.DigitalIDV.Command.Application.Dto.IdvRequirementStatus.CreateIdvRequirementStatusModelRequestDto to create",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateIdvRequirementStatusModelRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateIdvRequirementStatusModelRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateIdvRequirementStatusModelRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Idv Requirement Model created successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdvReqStatusModelResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdvReqStatusModelResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdvReqStatusModelResponseDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/idv-requirement-status/create-single-status": {
"post": {
"tags": [
"IdvRequirementStatus"
],
"summary": "Create single Idv Requirement Status.",
"description": "\nThis method will create a new Idv Requirement Status\n The new model will initialize with the DTO data.\n\nParent model will be created if it has not been created already.
Required permissions:
Following permissions are required: IdvEdit",
"operationId": "CreateSingleIdvRequirementStatusModel",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "ServiceRequest with the Fenergo.Nebula.DigitalIDV.Command.Application.Dto.IdvRequirementStatus.CreateSingleIdvRequirementStatusRequestDto to create",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateSingleIdvRequirementStatusRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateSingleIdvRequirementStatusRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateSingleIdvRequirementStatusRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Idv Requirement Status created successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdvReqStatusModelResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdvReqStatusModelResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdvReqStatusModelResponseDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/idv-requirement-status/{id}": {
"put": {
"tags": [
"IdvRequirementStatus"
],
"summary": "Update existing Idv Requirement Status Model.",
"description": "\nThis method will update an existing Idv Requirement Status Model\n The model will be updated with the DTO data.
Required permissions:
Following permissions are required: IdvEdit",
"operationId": "UpdateIdvRequirementStatusModel",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The identifier.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "ServiceRequest with the Fenergo.Nebula.DigitalIDV.Command.Application.Dto.IdvRequirementStatus.UpdateIdvReqStatusModelRequestDto to update",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateIdvReqStatusModelRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateIdvReqStatusModelRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateIdvReqStatusModelRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Idv Requirement Model updated successfully"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/idv-requirement-status/update-single-status/{id}": {
"put": {
"tags": [
"IdvRequirementStatus"
],
"summary": "Update single Idv Requirement Status.",
"description": "\nThis method will update a single Idv Requirement Status.
Required permissions:
Following permissions are required: IdvEdit",
"operationId": "UpdateSingleIdvRequirementStatus",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The identifier.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "ServiceRequest with the Fenergo.Nebula.DigitalIDV.Command.Application.Dto.IdvRequirementStatus.SingleIdvReqStatusRequestDto to update",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleIdvReqStatusRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleIdvReqStatusRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/SingleIdvReqStatusRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Idv Requirement Model updated successfully"
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/idv-requirement-status/measure-completeness": {
"post": {
"tags": [
"IdvRequirementStatus"
],
"summary": "Measures the completeness of Ownership and Control Idv requirements",
"description": "
Required permissions:
At least one of the following permissions is required: IdvEdit, IdvAccess",
"operationId": "MeasureCompleteness",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "ServiceRequest with the Fenergo.Nebula.DigitalIDV.MeasureCompleteness.Dto.MeasureCompletenessRequestDto data used in the calculation",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MeasureCompletenessRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MeasureCompletenessRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/MeasureCompletenessRequestDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Idv Requirements successfully evaluated",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/MeasureCompletenessResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/MeasureCompletenessResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MeasureCompletenessResponseDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/scoping-rule-set": {
"post": {
"tags": [
"ScopingRuleSet"
],
"summary": "Create scoping rule set",
"description": "\n - Creates a new scoping rule set with a first draft version.
\n - The new version is initialized with the provided data, a default \"Draft\" status\n and the author as the only required signee.
\n
Required permissions:
Following permissions are required: IdvConfigurationEdit",
"operationId": "CreateScopingRuleSet",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateScopingRuleSetDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateScopingRuleSetDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateScopingRuleSetDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Scoping rule set created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/scoping-rule-set/{scopingRuleSetId}": {
"post": {
"tags": [
"ScopingRuleSet"
],
"summary": "Create scoping rule set version",
"description": "\n - Creates a new version of an existing scoping rule set.
\n - Assigns the next available version number.
\n - The new version is initialized with the provided data, a default \"Draft\" status\n and the author as the only required signee.
\n
Required permissions:
Following permissions are required: IdvConfigurationEdit",
"operationId": "CreateScopingRuleSetVersion",
"parameters": [
{
"name": "scopingRuleSetId",
"in": "path",
"description": "Scoping rule set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "Create scoping rule set version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateScopingRuleSetVersionDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateScopingRuleSetVersionDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateScopingRuleSetVersionDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Scoping rule set version created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateScopingRuleSetResponseDtoServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Scoping rule set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
},
"delete": {
"tags": [
"ScopingRuleSet"
],
"summary": "Delete scoping rule set and all its versions",
"description": "\nDeletes an existing scoping rule set and all its versions.
Required permissions:
Following permissions are required: IdvConfigurationDelete",
"operationId": "DeleteScopingRuleSet",
"parameters": [
{
"name": "scopingRuleSetId",
"in": "path",
"description": "Scoping rule set Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"202": {
"description": "Success. Scoping rule set deleted"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Scoping rule set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}": {
"put": {
"tags": [
"ScopingRuleSet"
],
"summary": "Update scoping rule set version",
"description": "\nUpdates an existing scoping rule set version. Only draft versions are allowed to be updated.
Required permissions:
Following permissions are required: IdvConfigurationEdit",
"operationId": "UpdateScopingRuleSetVersion",
"parameters": [
{
"name": "scopingRuleSetId",
"in": "path",
"description": "Scoping rule set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to update",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "Update scoping rule set version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateScopingRuleSetVersionDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateScopingRuleSetVersionDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateScopingRuleSetVersionDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Scoping rule set version updated",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/UpdateScopingRuleSetResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateScopingRuleSetResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateScopingRuleSetResponseDtoServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Scoping rule set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"409": {
"description": "Conflict saving changes in expected version",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes",
"type": "Error",
"errorCode": "CONFLICT"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
},
"delete": {
"tags": [
"ScopingRuleSet"
],
"summary": "Delete scoping rule set version",
"description": "\n - Deletes the selected version of an existing scoping rule set.
\n - If the version is the last one, then the version number of it will become the next available one for the model.
\n
Required permissions:
Following permissions are required: IdvConfigurationDelete",
"operationId": "DeleteScopingRuleSetVersion",
"parameters": [
{
"name": "scopingRuleSetId",
"in": "path",
"description": "Scoping rule set Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to delete",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"202": {
"description": "Success. Scoping rule set version deleted"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Scoping rule set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}/clone": {
"post": {
"tags": [
"ScopingRuleSet"
],
"summary": "Clone scoping rule set version",
"description": "\n - Clones the selected version of an existing scoping rule set and creates a new model with a single version.
\n - The new version contains all the data of the original selected one,\n will have the default status of draft and the author as the only required signee.
\n - Returns the id of the cloned data group version.
\n
Required permissions:
Following permissions are required: IdvConfigurationEdit",
"operationId": "CloneScopingRuleSetVersion",
"parameters": [
{
"name": "scopingRuleSetId",
"in": "path",
"description": "Scoping rule set Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to clone",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "Clone scoping rule set version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CloneScopingRuleSetVersionDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CloneScopingRuleSetVersionDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CloneScopingRuleSetVersionDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Scoping rule set version cloned",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CloneScopingRuleSetVersionResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloneScopingRuleSetVersionResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CloneScopingRuleSetVersionResponseDtoServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Scoping rule set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}/submit-for-approval": {
"put": {
"tags": [
"ScopingRuleSet"
],
"summary": "Submit scoping rule set version for approval",
"description": "\nSubmits the selected version of an existing scoping rule set for approval.
Required permissions:
Following permissions are required: IdvConfigurationEdit",
"operationId": "SubmitScopingRuleSetVersion",
"parameters": [
{
"name": "scopingRuleSetId",
"in": "path",
"description": "Scoping rule set Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to submit",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"202": {
"description": "Success. Scoping rule set version submitted"
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Scoping rule set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}/sign": {
"put": {
"tags": [
"ScopingRuleSet"
],
"summary": "Sign scoping rule set version",
"description": "\nSigns the selected version of an existing scoping rule set and changes the version status accordingly to the action (Approve/Reject).
Required permissions:
Following permissions are required: IdvConfigurationApprove",
"operationId": "SignScopingRuleSetVersion",
"parameters": [
{
"name": "scopingRuleSetId",
"in": "path",
"description": "Scoping rule set Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to sign",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "Sign scoping rule set version request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApproveActionServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApproveActionServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ApproveActionServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Success. Scoping rule set version signed",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SignScopingRuleSetVersionResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SignScopingRuleSetVersionResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SignScopingRuleSetVersionResponseDtoServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Scoping rule set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}/archive": {
"put": {
"tags": [
"ScopingRuleSet"
],
"summary": "Archive scoping rule set version",
"description": "\nArchives the selected version of an existing scoping rule set.
Required permissions:
Following permissions are required: IdvConfigurationArchive",
"operationId": "ArchiveScopingRuleSetVersion",
"parameters": [
{
"name": "scopingRuleSetId",
"in": "path",
"description": "Scoping rule set Id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Version number to archive",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"202": {
"description": "Success. Scoping rule set version archived"
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Scoping rule set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/verification": {
"post": {
"tags": [
"Verification"
],
"summary": "Initiate Verification",
"description": "
Required permissions:
Following permissions are required: DigitalIdvAccess, DigitalIdvCreate",
"operationId": "InitiateVerification",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InitiateVerificationDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InitiateVerificationDtoServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/InitiateVerificationDtoServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/InitiateVerificationResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InitiateVerificationResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/InitiateVerificationResponseDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/verification/documentIdvValidation": {
"post": {
"tags": [
"Verification"
],
"summary": "Complete a Document Validation Check",
"description": "\nThis method will create and store an identification document validation result\n The result will be stored and be unique for the specific document validation result and as part of the specific journey task UiD
Required permissions:
Following permissions are required: DigitalIdvAccess",
"operationId": "DocumentIdvValidation",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "ServiceRequest with the Fenergo.Nebula.DigitalIDV.Common.Dto.IdvDocumentValidationRequest to create",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/IdvDocumentValidationRequestServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/IdvDocumentValidationRequestServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/IdvDocumentValidationRequestServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Document Validation Record created successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdvDocumentValidationResponseServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdvDocumentValidationResponseServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdvDocumentValidationResponseServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/verification/faceIdvSimilarity": {
"post": {
"tags": [
"Verification"
],
"summary": "Complete a Face Similarity and Document Validation Check",
"description": "\nThis method will create and store an identification document validation result and a Face Similarity validation result\n The result will be stored and be unique for the specific document and face validation result and as part of the specific journey task UiD
Required permissions:
Following permissions are required: DigitalIdvAccess",
"operationId": "FaceIdvSimilarity",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "ServiceRequest with the Fenergo.Nebula.DigitalIDV.Common.Dto.IdvFaceSimilarityRequest to create",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/IdvFaceSimilarityRequestServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/IdvFaceSimilarityRequestServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/IdvFaceSimilarityRequestServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "Document Validation and Face similarity Record created successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdvFaceSimilarityResponseServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdvFaceSimilarityResponseServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdvFaceSimilarityResponseServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/verification/entity/{entityId}/journey/{journeyId}": {
"put": {
"tags": [
"Verification"
],
"summary": "Update an existing identity verification result",
"description": "\nThis method will update an an existing identity verification result
Required permissions:
Following permissions are required: DigitalIdvAccess",
"operationId": "UpdateIdentityVerificationResult",
"parameters": [
{
"name": "entityId",
"in": "path",
"description": "The entity id of the identity verification result to update",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "journeyId",
"in": "path",
"description": "The journey id of the identity verification result to update",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "The data of the identity verification result we want to update",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateIdentityVerificationResultRequestServiceRequest"
}
],
"description": "Service request data"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateIdentityVerificationResultRequestServiceRequest"
}
],
"description": "Service request data"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateIdentityVerificationResultRequestServiceRequest"
}
],
"description": "Service request data"
}
}
}
},
"responses": {
"202": {
"description": "The identity verification result was updated successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdentityVerificationResultsDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityVerificationResultsDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdentityVerificationResultsDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"500": {
"description": "An exception occurred while processing the command"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AccessLayers": {
"type": "object",
"properties": {
"geographic": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"businessRelated": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"ApproveAction": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"nullable": true
},
"decision": {
"allOf": [
{
"$ref": "#/components/schemas/Decision"
}
]
},
"created": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"ApproveActionServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ApproveAction"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"Approver": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"nullable": true
},
"successor": {
"allOf": [
{
"$ref": "#/components/schemas/Approver"
}
],
"nullable": true
},
"action": {
"allOf": [
{
"$ref": "#/components/schemas/ApproveAction"
}
],
"nullable": true
},
"hasProcessedRequest": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"AreaArray": {
"type": "object",
"properties": {
"count": {
"type": "number",
"format": "double"
},
"list": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RectangleCoordinates"
},
"nullable": true
},
"points": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PointArray"
},
"nullable": true
}
},
"additionalProperties": false
},
"AreaContainer": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"list": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RectangleCoordinates"
},
"nullable": true
},
"points": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PointsContainer"
},
"nullable": true
}
},
"additionalProperties": false
},
"AuthenticityCheckList": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"list": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthenticityCheckResult"
},
"nullable": true
}
},
"additionalProperties": false
},
"AuthenticityCheckResult": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/AuthenticityResultType"
}
]
},
"result": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"count": {
"type": "integer",
"format": "int32",
"nullable": true
},
"list": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthenticityCheckResultItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"AuthenticityCheckResultItem": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/AuthenticityResultType"
}
]
},
"elementResult": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
],
"nullable": true
},
"elementDiagnose": {
"allOf": [
{
"$ref": "#/components/schemas/CheckDiagnose"
}
],
"nullable": true
},
"percentValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"AuthenticityResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"authenticityCheckList": {
"allOf": [
{
"$ref": "#/components/schemas/AuthenticityCheckList"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"AuthenticityResultType": {
"enum": [
1,
2,
4,
8,
16,
32,
64,
128,
512,
1024,
4096,
8192,
32768,
65536,
131072,
262144,
524288,
1048576,
2097152,
4194304,
8388608,
16777216,
33554432
],
"type": "integer",
"format": "int64"
},
"BSIV2Result": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"xmlBuffer": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"BarCodeModuleType": {
"enum": [
0,
1,
2,
3,
4
],
"type": "integer",
"format": "int32"
},
"BarcodePositionResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"barcodePosition": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentPosition"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"BarcodeType": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19
],
"type": "integer",
"format": "int32"
},
"BcPDF417INFO": {
"type": "object",
"properties": {
"angle": {
"type": "number",
"format": "float"
},
"bcColumn": {
"type": "integer",
"format": "int32"
},
"bcErrorLevel": {
"type": "integer",
"format": "int32"
},
"bcRow": {
"type": "integer",
"format": "int32"
},
"minX": {
"type": "number",
"format": "float"
},
"minY": {
"type": "number",
"format": "float"
}
},
"additionalProperties": false
},
"BcROIDETECT": {
"type": "object",
"properties": {
"bottom": {
"type": "integer",
"format": "int32"
},
"left": {
"type": "integer",
"format": "int32"
},
"right": {
"type": "integer",
"format": "int32"
},
"top": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"BinaryData": {
"type": "object",
"properties": {
"rfidAuthenticationInfo": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfidmifareDataValidity": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfidmifareData": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfiD_EF_COM": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfiddG1": {
"allOf": [
{
"$ref": "#/components/schemas/RfidDG1"
}
],
"nullable": true
},
"rfiddG2": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfiddG3": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfiddG4": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfiddG5": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfiddG6": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfiddG7": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfiddG8": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfiddG9": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfiddG10": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfiddG11": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfiddG12": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfiddG13": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfiddG14": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfiddG15": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfiddG16": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfiD_EF_SOD": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG1": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG2": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG3": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG4": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG5": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG6": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG7": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG8": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG9": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG10": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG11": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG12": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG13": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG14": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG15": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG16": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG17": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG18": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG19": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG20": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"eiddG21": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"edlcom": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"edlsod": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"edldG1": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"edldG2": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"edldG3": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"edldG4": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"edldG5": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"edldG6": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"edldG7": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"edldG8": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"edldG9": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"edldG10": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"edldG11": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"edldG12": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"edldG13": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"edldG14": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"visibleDigitalSeal": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"visibleDigitalSealNC": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"digitalSignature": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"rfidSessionData": {
"allOf": [
{
"$ref": "#/components/schemas/RfidSessionData"
}
],
"nullable": true
},
"rfidSessionDataStatus": {
"allOf": [
{
"$ref": "#/components/schemas/DetailsRFID"
}
],
"nullable": true
},
"rfidePasspDirectory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RfidDataFileType"
},
"nullable": true
}
},
"additionalProperties": false
},
"BooleanServiceRequest": {
"type": "object",
"properties": {
"data": {
"type": "boolean",
"description": "The service request DTO"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"BooleanServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "boolean",
"description": "The service response DTO"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"ByteArrayResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"byteArray": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"CertificateData": {
"type": "object",
"properties": {
"data": {
"type": "string",
"nullable": true
},
"length": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"CheckDiagnose": {
"enum": [
0,
1,
2,
3,
4,
5,
7,
8,
10,
11,
12,
13,
14,
15,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
33,
34,
40,
41,
42,
43,
44,
50,
51,
52,
53,
54,
55,
60,
65,
66,
67,
80,
81,
82,
83,
84,
85,
86,
87,
88,
90,
91,
92,
93,
94,
95,
96,
100,
101,
102,
103,
104,
110,
111,
112,
113,
114,
115,
116,
117,
118,
119,
120,
121,
122,
130,
131,
132,
133,
134,
140,
141,
142,
143,
144,
145,
150,
151,
152,
153,
154,
155,
156,
160,
161,
170,
180,
181,
182,
183,
184,
185,
186,
187,
190,
200,
201,
202,
203,
204,
205,
220,
221,
222,
230,
238,
239,
240,
241,
242,
243,
244,
245,
246,
247,
248,
250,
260,
261,
262
],
"type": "integer",
"format": "int32"
},
"CheckResult": {
"enum": [
0,
1,
2
],
"type": "integer",
"format": "int32"
},
"ChosenDocumentTypeResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"oneCandidate": {
"allOf": [
{
"$ref": "#/components/schemas/OneCandidate"
}
],
"nullable": true
},
"xmlBuffer": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
}
]
},
"CloneScopingRuleSetVersionDto": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"minLength": 1,
"type": "string",
"description": "Name of new scoping rule set",
"example": "Shareholder Scoping Rules"
}
},
"additionalProperties": false,
"description": "Request DTO representing clone scoping rule set data"
},
"CloneScopingRuleSetVersionDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CloneScopingRuleSetVersionDto"
}
],
"description": "Request DTO representing clone scoping rule set data",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"CloneScopingRuleSetVersionResponseDto": {
"type": "object",
"properties": {
"scopingRuleSetId": {
"type": "string",
"description": "Id of the cloned scoping rule set",
"format": "uuid",
"example": "7084669b-0813-4faa-b1d5-b7bf6d749717"
}
},
"additionalProperties": false,
"description": "Cloned scoping rule set response data"
},
"CloneScopingRuleSetVersionResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CloneScopingRuleSetVersionResponseDto"
}
],
"description": "Cloned scoping rule set response data",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"ConditionDefinitionDto": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Name of the field to evaluate",
"nullable": true,
"example": "EntityType"
},
"value": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of values",
"nullable": true
},
"valueId": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of value ids",
"nullable": true
},
"valueType": {
"type": "string",
"description": "Type of the value",
"nullable": true,
"example": "text"
},
"dataSource": {
"type": "string",
"description": "Data source from which field is retrieved. If empty then Entity Data properties will be used.",
"nullable": true,
"example": "entityDataMetadata"
},
"operation": {
"type": "string",
"description": "Logical operation to be performed to match the values",
"nullable": true,
"example": "equal"
},
"logicalOperation": {
"type": "string",
"description": "Logical operation to be performed on the operands collection",
"nullable": true,
"example": "AND"
},
"operands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDefinitionDto"
},
"description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto",
"nullable": true
},
"valueField": {
"allOf": [
{
"$ref": "#/components/schemas/ValueField"
}
],
"description": "Field value used for conditional limit validation",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents condition"
},
"ConditionDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the condition",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"name": {
"type": "string",
"description": "The name of the condition",
"nullable": true,
"example": "Company-type only"
},
"description": {
"type": "string",
"description": "The description of the condition",
"nullable": true,
"example": "Applicable only when EntityType=Company"
},
"logicalOperation": {
"type": "string",
"description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection",
"nullable": true,
"example": "AND"
},
"operands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDefinitionDto"
},
"description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents condition root"
},
"ConditionalValueDto": {
"allOf": [
{
"$ref": "#/components/schemas/StringConditionalValueDto"
},
{
"type": "object",
"properties": {
"valueId": {
"type": "string",
"description": "Value Id that should be returned when conditions are met",
"nullable": true,
"example": "RM"
}
},
"additionalProperties": false
}
]
},
"ConditionalValueDto`1": {
"allOf": [
{
"$ref": "#/components/schemas/ConditionDto"
},
{
"type": "object",
"properties": {
"value": {
"allOf": [
{
"$ref": "#/components/schemas/T"
}
],
"description": "Value that should be returned when conditions are met",
"nullable": true
},
"priority": {
"type": "integer",
"description": "Priority of the value in case when multiple conditional values are evaluated",
"format": "int32",
"example": 1
}
},
"additionalProperties": false
}
]
},
"ContainerList": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32",
"nullable": true
},
"list": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResultItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"CreateDraftIdvConfigurationDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"version": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"CreateDraftIdvConfigurationDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CreateDraftIdvConfigurationDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"CreateIdvRequirementStatusModelRequestDto": {
"type": "object",
"properties": {
"entityId": {
"type": "string",
"description": "The Id of the Entity",
"format": "uuid",
"example": "18c086ce-f3e1-4311-af6a-1c3fe4f6b6ba"
},
"journeyId": {
"type": "string",
"description": "The Id of the Journey",
"format": "uuid",
"example": "088f2d94-f2e1-4afb-b908-498a76ebf771"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SingleIdvReqStatusRequestDto"
},
"description": "The statuses of the Idv requirements",
"nullable": true
}
},
"additionalProperties": false,
"description": "Contains all the information needed to store the status of the Idv Requirement Model"
},
"CreateIdvRequirementStatusModelRequestDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CreateIdvRequirementStatusModelRequestDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"CreateScopingRuleSetDto": {
"allOf": [
{
"$ref": "#/components/schemas/CreateScopingRuleSetVersionDto"
},
{
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"minLength": 1,
"type": "string",
"description": "Scoping rule set name",
"example": "Global"
}
},
"additionalProperties": false
}
],
"description": "DTO representing scoping rule set data needed for creation"
},
"CreateScopingRuleSetDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CreateScopingRuleSetDto"
}
],
"description": "DTO representing scoping rule set data needed for creation",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"CreateScopingRuleSetResponseDto": {
"allOf": [
{
"$ref": "#/components/schemas/CreateScopingRuleSetDto"
},
{
"required": [
"signees"
],
"type": "object",
"properties": {
"scopingRuleSetId": {
"type": "string",
"description": "The UiD of scoping rule set",
"format": "uuid",
"example": "7084669b-0813-4faa-b1d5-b7bf6d749717"
},
"versionNumber": {
"type": "integer",
"description": "The version number",
"format": "int32",
"example": 1
},
"created": {
"type": "string",
"description": "The creation date of the version (Read-only)",
"format": "date-time",
"example": "2021-01-05T14:48:00.000Z"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
],
"description": "The status of the version",
"example": "Draft"
},
"signees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SigneeDto"
},
"description": "The defined list of signees for the version"
}
},
"additionalProperties": false
}
],
"description": "DTO representing scoping rule set data"
},
"CreateScopingRuleSetResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CreateScopingRuleSetResponseDto"
}
],
"description": "DTO representing scoping rule set data",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"CreateScopingRuleSetVersionDto": {
"type": "object",
"properties": {
"effectiveFrom": {
"type": "string",
"description": "The date that the version takes effect when published",
"format": "date-time",
"example": "2021-01-05T14:48:00.000Z"
},
"notes": {
"type": "string",
"description": "Notes related to the Related Party Scoping Rules Version",
"nullable": true
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "Conditions under which the schema can be used",
"nullable": true
}
},
"additionalProperties": false,
"description": "DTO representing scoping rule set data needed for version creation"
},
"CreateScopingRuleSetVersionDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CreateScopingRuleSetVersionDto"
}
],
"description": "DTO representing scoping rule set data needed for version creation",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"CreateSingleIdvRequirementStatusRequestDto": {
"type": "object",
"properties": {
"entityId": {
"type": "string",
"description": "The Id of the Entity",
"format": "uuid",
"example": "18c086ce-f3e1-4311-af6a-1c3fe4f6b6ba"
},
"journeyId": {
"type": "string",
"description": "The Id of the Journey",
"format": "uuid",
"example": "088f2d94-f2e1-4afb-b908-498a76ebf771"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/SingleIdvReqStatusRequestDto"
}
],
"description": "Contains the data for updating an Idv Requirement Status",
"nullable": true
}
},
"additionalProperties": false,
"description": "Contains all the information needed to store the status of the Idv Requirement"
},
"CreateSingleIdvRequirementStatusRequestDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CreateSingleIdvRequirementStatusRequestDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"Critical": {
"enum": [
0,
1
],
"type": "integer",
"format": "int32"
},
"CrossSourceValueComparison": {
"type": "object",
"properties": {
"sourceLeft": {
"allOf": [
{
"$ref": "#/components/schemas/Source"
}
]
},
"sourceRight": {
"allOf": [
{
"$ref": "#/components/schemas/Source"
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
}
},
"additionalProperties": false
},
"DataModule": {
"type": "object",
"properties": {
"mType": {
"allOf": [
{
"$ref": "#/components/schemas/BarCodeModuleType"
}
]
},
"mData": {
"type": "string",
"nullable": true
},
"mLength": {
"type": "integer",
"format": "int32"
},
"mReserved1": {
"type": "integer",
"format": "int32",
"nullable": true
},
"mReserver2": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"Decision": {
"enum": [
"Approve",
"Reject"
],
"type": "string"
},
"DetailsAge": {
"type": "object",
"properties": {
"overThreshold": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"over18": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"over21": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"over25": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"over65": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"threshold": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"DetailsOptical": {
"type": "object",
"properties": {
"overallStatus": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"docType": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"expiry": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"imageQA": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"mrz": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"security": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"text": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"pagesCount": {
"type": "integer",
"format": "int32"
},
"vds": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"DetailsRFID": {
"type": "object",
"properties": {
"overallStatus": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"aa": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"bac": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"ca": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"pa": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"pace": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"ta": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
}
},
"additionalProperties": false
},
"DetectionFace": {
"type": "object",
"properties": {
"faceIndex": {
"type": "number",
"format": "double"
},
"landmarks": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"nullable": true
},
"rotationAngle": {
"type": "number",
"format": "double"
},
"roi": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
},
"crop": {
"type": "string",
"format": "byte",
"nullable": true
}
},
"additionalProperties": false
},
"DocBarCodeInfo": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"varDocBarCodeInfo": {
"allOf": [
{
"$ref": "#/components/schemas/DocBarCodeInfoFieldsList"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"DocBarCodeInfoFieldsList": {
"type": "object",
"properties": {
"nFields": {
"type": "integer",
"format": "int32"
},
"pArrayFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PArrayField"
},
"nullable": true
}
},
"additionalProperties": false
},
"DocFeature": {
"type": "object",
"properties": {
"type": {
"type": "number",
"format": "double"
},
"data": {
"allOf": [
{
"$ref": "#/components/schemas/TrfFtBytes"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"DocVisualExtendedField": {
"allOf": [
{
"$ref": "#/components/schemas/VisualExtendedFieldItem"
},
{
"type": "object",
"properties": {
"fieldRect": {
"allOf": [
{
"$ref": "#/components/schemas/RectangleCoordinates"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"DocVisualExtendedInfo": {
"type": "object",
"properties": {
"nFields": {
"type": "number",
"format": "double"
},
"pArrayFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocVisualExtendedField"
},
"nullable": true
}
},
"additionalProperties": false
},
"DocumentBinaryInfoResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"tDocBinaryInfo": {
"allOf": [
{
"$ref": "#/components/schemas/TDocBinaryInfo"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"DocumentFormat": {
"enum": [
0,
1,
2,
3,
4,
5,
10,
11,
12,
13,
14,
1000,
1002,
-1
],
"type": "integer",
"format": "int32"
},
"DocumentImageResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"rawImageContainer": {
"allOf": [
{
"$ref": "#/components/schemas/ImageData"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"DocumentLivenessChecks": {
"type": "object",
"properties": {
"electronicDevice": {
"type": "integer",
"format": "int32"
},
"multipleLaserImages": {
"type": "integer",
"format": "int32"
},
"opticalVariableInk": {
"type": "integer",
"format": "int32"
},
"hologramDetectionSimple": {
"type": "integer",
"format": "int32"
},
"hologramDetectionStatic": {
"type": "integer",
"format": "int32"
},
"hologramDetectionMultiStatic": {
"type": "integer",
"format": "int32"
},
"hologramDetectionDynamic": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"DocumentPosition": {
"type": "object",
"properties": {
"docFormat": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentFormat"
}
]
},
"angle": {
"type": "number",
"format": "double"
},
"width": {
"type": "integer",
"format": "int32"
},
"height": {
"type": "integer",
"format": "int32"
},
"center": {
"allOf": [
{
"$ref": "#/components/schemas/Point"
}
],
"nullable": true
},
"leftBottom": {
"allOf": [
{
"$ref": "#/components/schemas/Point"
}
],
"nullable": true
},
"leftTop": {
"allOf": [
{
"$ref": "#/components/schemas/Point"
}
],
"nullable": true
},
"rightBottom": {
"allOf": [
{
"$ref": "#/components/schemas/Point"
}
],
"nullable": true
},
"rightTop": {
"allOf": [
{
"$ref": "#/components/schemas/Point"
}
],
"nullable": true
},
"dpi": {
"type": "integer",
"format": "int32"
},
"inverse": {
"type": "integer",
"format": "int32",
"nullable": true
},
"objArea": {
"type": "integer",
"format": "int32",
"nullable": true
},
"objIntAngleDev": {
"type": "integer",
"format": "int32",
"nullable": true
},
"perspectiveTr": {
"type": "integer",
"format": "int32",
"nullable": true
},
"resultStatus": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"DocumentPositionResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"documentPosition": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentPosition"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"DocumentType": {
"enum": [
0,
11,
12,
13,
14,
15,
16,
17,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
82,
83,
84,
85,
86,
87,
88,
89,
90,
91,
92,
93,
94,
95,
96,
97,
98,
99,
100,
101,
102,
103,
104,
105,
106,
107,
108,
109,
110,
111,
112,
113,
114,
115,
116,
117,
118,
119,
120,
121,
122,
123,
124,
125,
126,
127,
128,
129,
130,
131,
132,
133,
134,
135,
136,
137,
138,
139,
140,
141,
142,
143,
144,
145,
146,
147,
148,
149,
150,
151,
152,
153,
154,
155,
156,
157,
158,
159,
160,
161,
162,
163,
164,
165,
166,
167,
168,
169,
170,
171,
172,
173,
174,
175,
176,
177,
178,
179,
180,
181,
182,
183,
184,
185,
186,
187,
188,
189,
190,
191,
192,
193,
194,
195,
196,
197,
198,
199,
200,
201,
202,
203,
204,
205,
206,
207,
208,
209,
210,
211,
212,
213,
214,
215,
216,
217,
218,
219,
220,
221,
222,
223,
224,
225,
226,
227,
228,
229,
230,
231,
232,
233,
234,
235,
236,
237,
238,
239,
240,
241,
242
],
"type": "integer",
"format": "int32"
},
"DocumentTypeRecognitionResult": {
"enum": [
0,
15,
29
],
"type": "integer",
"format": "int32"
},
"DocumentTypesCandidatesList": {
"type": "object",
"properties": {
"recResult": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentTypeRecognitionResult"
}
],
"nullable": true
},
"candidates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OneCandidate"
},
"nullable": true
}
},
"additionalProperties": false
},
"DocumentTypesCandidatesResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"candidatesList": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentTypesCandidatesList"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"DocumentVerificationChecks": {
"type": "object",
"properties": {
"uvLuminescence": {
"type": "integer",
"format": "int32"
},
"b900InkInInfraredLight": {
"type": "integer",
"format": "int32"
},
"imagePatternCheck": {
"type": "integer",
"format": "int32"
},
"axialProtection": {
"type": "integer",
"format": "int32"
},
"protectionFibersUV": {
"type": "integer",
"format": "int32"
},
"infraredVisibility": {
"type": "integer",
"format": "int32"
},
"ocrSecurityText": {
"type": "integer",
"format": "int32"
},
"ipiVisualization": {
"type": "integer",
"format": "int32"
},
"photoEmbeddingType": {
"type": "integer",
"format": "int32"
},
"hologramPresence": {
"type": "integer",
"format": "int32"
},
"photoAreaCheck": {
"type": "integer",
"format": "int32"
},
"portraitComparison": {
"type": "integer",
"format": "int32"
},
"barcodeFormat": {
"type": "integer",
"format": "int32"
},
"kinegram": {
"type": "integer",
"format": "int32"
},
"letterScreen": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"DocumentsDatabase": {
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true
},
"exportDate": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"varVersion": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EncryptedRCLResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"encryptedRCL": {
"type": "string",
"format": "byte",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"EntityInScopeForIdvRequestDto": {
"type": "object",
"properties": {
"entityId": {
"type": "string",
"description": "The Id of the Entity the which is in scope for Idv",
"nullable": true,
"example": "315df981-38a0-4145-836b-8d22745887b6"
},
"journeyId": {
"type": "string",
"description": "The Id of the Journey the Entity in scope for Idv is on",
"nullable": true,
"example": "19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769"
}
},
"additionalProperties": false
},
"EntityInScopeForIdvRequestDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/EntityInScopeForIdvRequestDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"EntityInScopeForIdvRequestDtoV2": {
"allOf": [
{
"$ref": "#/components/schemas/EntityInScopeForIdvRequestDto"
},
{
"type": "object",
"properties": {
"ruleSetId": {
"type": "string",
"description": "The Id of the ruleset for the task which in scope for Idv",
"nullable": true,
"example": "19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769"
}
},
"additionalProperties": false
}
]
},
"EntityInScopeForIdvResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The Id of the Entity in Scope for Idv",
"format": "uuid",
"example": "dc30fd5b-120b-4aaa-bed7-8d8508e24de5"
},
"entityId": {
"type": "string",
"description": "The Id of the Entity the which is in Scope for Idv",
"nullable": true,
"example": "315df981-38a0-4145-836b-8d22745887b6"
},
"journeyId": {
"type": "string",
"description": "The Id of the Journey the Entity in Scope for Idv is on",
"nullable": true,
"example": "19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769"
},
"status": {
"type": "string",
"description": "The status of the Entity in Scope for Idv",
"nullable": true,
"example": "Pending Data"
}
},
"additionalProperties": false
},
"EntityInScopeForIdvResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/EntityInScopeForIdvResponseDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"EntityInScopeForIdvResponseDtoV2": {
"allOf": [
{
"$ref": "#/components/schemas/EntityInScopeForIdvResponseDto"
},
{
"type": "object",
"properties": {
"ruleSetId": {
"type": "string",
"description": "The Id of the ruleset for the task which in scope for Idv",
"nullable": true,
"example": "19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769"
},
"isExcluded": {
"type": "boolean",
"description": "Is entity excluded from scope for Idv",
"example": false
}
},
"additionalProperties": false
}
]
},
"ErrorCoordinates": {
"type": "object",
"properties": {
"left": {
"type": "number",
"format": "double",
"nullable": true
},
"top": {
"type": "number",
"format": "double",
"nullable": true
},
"right": {
"type": "number",
"format": "double",
"nullable": true
},
"bottom": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"EvaluateAndSetIdvStatusResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"entityId": {
"type": "string",
"format": "uuid"
},
"journeyId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"EvaluateAndSetIdvStatusResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/EvaluateAndSetIdvStatusResponseDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"EvaluateIdvStatusExtendedRequestDto": {
"allOf": [
{
"$ref": "#/components/schemas/EvaluateIdvStatusRequestDto"
},
{
"type": "object",
"properties": {
"parentEntities": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"gatheredComplianceData": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
}
]
},
"EvaluateIdvStatusRequestDto": {
"type": "object",
"properties": {
"journeyId": {
"type": "string",
"format": "uuid"
},
"taskId": {
"type": "string",
"format": "uuid"
},
"entityId": {
"type": "string",
"format": "uuid"
},
"entityDraftId": {
"type": "string",
"format": "uuid"
},
"rootId": {
"type": "string",
"format": "uuid"
},
"parentDraftId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"EvaluateIdvStatusRequestDtoServiceRequest": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/EvaluateIdvStatusRequestDto"
}
],
"description": "The service request DTO"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"FDSIDList": {
"type": "object",
"properties": {
"dType": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentType"
}
]
},
"dFormat": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentFormat"
}
]
},
"icaoCode": {
"type": "string",
"nullable": true
},
"count": {
"type": "number",
"format": "double",
"nullable": true
},
"list": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"dmrz": {
"type": "boolean"
},
"dDescription": {
"type": "string",
"nullable": true
},
"dYear": {
"type": "string",
"nullable": true
},
"dCountryName": {
"type": "string",
"nullable": true
},
"dStateCode": {
"type": "string",
"nullable": true
},
"dStateName": {
"type": "string",
"nullable": true
},
"isDeprecated": {
"type": "boolean"
}
},
"additionalProperties": false
},
"FaceDetection": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"countFalseDetection": {
"type": "integer",
"format": "int32"
},
"res": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FaceItem"
},
"nullable": true
},
"reserved1": {
"type": "integer",
"format": "int32",
"nullable": true
},
"reserved2": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"FaceDetectionResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"faceDetection": {
"allOf": [
{
"$ref": "#/components/schemas/FaceDetection"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"FaceItem": {
"type": "object",
"properties": {
"lightType": {
"allOf": [
{
"$ref": "#/components/schemas/Light"
}
]
},
"coincidenceToPhotoArea": {
"type": "integer",
"format": "int32"
},
"faceRect": {
"allOf": [
{
"$ref": "#/components/schemas/RectangleCoordinates"
}
],
"nullable": true
},
"fieldRect": {
"allOf": [
{
"$ref": "#/components/schemas/RectangleCoordinates"
}
],
"nullable": true
},
"graphFieldNumber": {
"type": "integer",
"format": "int32"
},
"landmarks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Point"
},
"nullable": true
},
"orientation": {
"type": "integer",
"format": "int32"
},
"probability": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"FaceSDKResultCode": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
199,
200,
201,
202,
203,
224,
227,
228,
229,
230,
231,
232,
233,
234,
235,
236,
237,
238,
239,
240,
242,
243,
244,
245,
246,
247,
248,
249,
250,
251,
252,
253,
254
],
"type": "integer",
"format": "int32"
},
"FiberResult": {
"allOf": [
{
"$ref": "#/components/schemas/AuthenticityCheckResultItem"
},
{
"type": "object",
"properties": {
"lightValue": {
"allOf": [
{
"$ref": "#/components/schemas/Light"
}
],
"nullable": true
},
"rectCount": {
"type": "integer",
"format": "int32"
},
"expectedCount": {
"type": "integer",
"format": "int32"
},
"lightDisp": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rectArray": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RectangleCoordinates"
},
"nullable": true
},
"width": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"length": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"area": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"colorValues": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
}
]
},
"FieldItem": {
"type": "object",
"properties": {
"fieldLength": {
"type": "integer",
"format": "int32"
},
"fieldPos": {
"type": "integer",
"format": "int32"
},
"fieldType": {
"type": "integer",
"format": "int32"
},
"tesT_RESULT": {
"type": "integer",
"format": "int32"
},
"validCheckSum": {
"type": "integer",
"format": "int32"
},
"reserved": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"FileImage": {
"type": "object",
"properties": {
"data": {
"type": "string",
"nullable": true
},
"length": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GraphData": {
"type": "object",
"properties": {
"fieldType": {
"type": "integer",
"format": "int32"
},
"fileImage": {
"allOf": [
{
"$ref": "#/components/schemas/FileImage"
}
],
"nullable": true
},
"graphicsType": {
"type": "integer",
"format": "int32"
},
"originDG": {
"type": "integer",
"format": "int32"
},
"originDGTag": {
"type": "integer",
"format": "int32"
},
"originEntryView": {
"type": "integer",
"format": "int32"
},
"originTagEntry": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"GraphicField": {
"type": "object",
"properties": {
"fieldType": {
"allOf": [
{
"$ref": "#/components/schemas/GraphicFieldType"
}
]
},
"fieldRect": {
"allOf": [
{
"$ref": "#/components/schemas/RectangleCoordinates"
}
],
"nullable": true
},
"fieldName": {
"type": "string",
"nullable": true
},
"image": {
"allOf": [
{
"$ref": "#/components/schemas/ImageData"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"GraphicFieldType": {
"enum": [
201,
202,
203,
204,
205,
206,
207,
208,
209,
210,
211,
212,
213,
250,
300,
301,
302,
303,
304,
305,
306,
307,
308,
309,
313,
314,
315
],
"type": "integer",
"format": "int32"
},
"GraphicFieldsList": {
"type": "object",
"properties": {
"pArrayFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphicField"
},
"nullable": true
},
"nFields": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"GraphicsResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"docGraphicsInfo": {
"allOf": [
{
"$ref": "#/components/schemas/GraphicFieldsList"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"GuidServiceRequest": {
"type": "object",
"properties": {
"data": {
"type": "string",
"description": "The service request DTO",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"HttpValidationProblemDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"type": "object",
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"nullable": true
}
},
"additionalProperties": { }
}
]
},
"IdentResult": {
"allOf": [
{
"$ref": "#/components/schemas/AuthenticityCheckResultItem"
},
{
"type": "object",
"properties": {
"elementType": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityFeatureType"
}
]
},
"lightIndex": {
"allOf": [
{
"$ref": "#/components/schemas/Light"
}
]
},
"area": {
"allOf": [
{
"$ref": "#/components/schemas/RectangleCoordinates"
}
],
"nullable": true
},
"image": {
"allOf": [
{
"$ref": "#/components/schemas/ImageData"
}
],
"nullable": true
},
"etalonImage": {
"allOf": [
{
"$ref": "#/components/schemas/ImageData"
}
],
"nullable": true
},
"areaList": {
"allOf": [
{
"$ref": "#/components/schemas/AreaContainer"
}
],
"nullable": true
},
"elementID": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"IdentityVerificationResultsDto": {
"type": "object",
"properties": {
"facialComparisonPercentageResult": {
"type": "string",
"nullable": true
},
"imageData": {
"allOf": [
{
"$ref": "#/components/schemas/ImagesData"
}
],
"nullable": true
},
"documentDetails": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
},
"results": {
"allOf": [
{
"$ref": "#/components/schemas/Results"
}
],
"nullable": true
},
"reviewResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReviewResult"
},
"nullable": true
},
"userEvaluationResult": {
"allOf": [
{
"$ref": "#/components/schemas/UserValidationResult"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"IdentityVerificationResultsDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/IdentityVerificationResultsDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"IdvBaseRequest": {
"type": "object",
"properties": {
"journeyId": {
"type": "string",
"nullable": true
},
"taskId": {
"type": "string",
"nullable": true
},
"entityId": {
"type": "string",
"nullable": true
},
"tenant": {
"type": "string",
"nullable": true
},
"configurationId": {
"type": "string",
"nullable": true
},
"startedDate": {
"type": "string",
"format": "date-time"
},
"accessLayers": {
"allOf": [
{
"$ref": "#/components/schemas/AccessLayers"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"IdvCommonPageConfigurationDto": {
"required": [
"message",
"title"
],
"type": "object",
"properties": {
"title": {
"minLength": 1,
"type": "string"
},
"message": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"IdvConfigurationDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"documentCaptureTypes": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"acceptedDocumentTypes": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"livenessType": {
"type": "string",
"nullable": true
},
"versionNotes": {
"type": "string",
"nullable": true
},
"livenessTestEnabled": {
"type": "boolean"
},
"version": {
"type": "integer",
"format": "int32"
},
"isDraft": {
"type": "boolean"
},
"isArchived": {
"type": "boolean"
},
"maxAttempts": {
"type": "integer",
"format": "int32"
},
"landingPageConfig": {
"allOf": [
{
"$ref": "#/components/schemas/IdvCommonPageConfigurationDto"
}
],
"nullable": true
},
"selfieStartScreenConfig": {
"allOf": [
{
"$ref": "#/components/schemas/IdvCommonPageConfigurationDto"
}
],
"nullable": true
},
"documentCaptureConfig": {
"allOf": [
{
"$ref": "#/components/schemas/IdvCommonPageConfigurationDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"IdvConfigurationDtoServiceRequest": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/IdvConfigurationDto"
}
],
"description": "The service request DTO"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"IdvConfigurationDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/IdvConfigurationDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"IdvDocumentValidationRequest": {
"allOf": [
{
"$ref": "#/components/schemas/IdvBaseRequest"
},
{
"type": "object",
"properties": {
"documentImage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"IdvDocumentValidationRequestServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/IdvDocumentValidationRequest"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"IdvDocumentValidationResponse": {
"type": "object",
"properties": {
"result": {
"type": "boolean"
}
},
"additionalProperties": false
},
"IdvDocumentValidationResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/IdvDocumentValidationResponse"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"IdvFaceSimilarityRequest": {
"allOf": [
{
"$ref": "#/components/schemas/IdvBaseRequest"
},
{
"type": "object",
"properties": {
"faceImage": {
"type": "string",
"nullable": true
},
"documentImage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"IdvFaceSimilarityRequestServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/IdvFaceSimilarityRequest"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"IdvFaceSimilarityResponse": {
"type": "object",
"properties": {
"result": {
"type": "boolean"
}
},
"additionalProperties": false
},
"IdvFaceSimilarityResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/IdvFaceSimilarityResponse"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"IdvNewConfigurationDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"documentCaptureTypes": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"acceptedDocumentTypes": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"livenessType": {
"type": "string",
"nullable": true
},
"versionNotes": {
"type": "string",
"nullable": true
},
"livenessTestEnabled": {
"type": "boolean"
},
"maxAttempts": {
"type": "integer",
"format": "int32"
},
"landingPageConfig": {
"allOf": [
{
"$ref": "#/components/schemas/IdvCommonPageConfigurationDto"
}
],
"nullable": true
},
"selfieStartScreenConfig": {
"allOf": [
{
"$ref": "#/components/schemas/IdvCommonPageConfigurationDto"
}
],
"nullable": true
},
"documentCaptureConfig": {
"allOf": [
{
"$ref": "#/components/schemas/IdvCommonPageConfigurationDto"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"IdvNewConfigurationDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/IdvNewConfigurationDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"IdvReqStatusModelResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the model",
"format": "uuid",
"example": "088f2d94-f2e1-4afb-b908-498a76ebf771"
},
"entityId": {
"type": "string",
"description": "The Id of the Entity",
"format": "uuid",
"example": "18c086ce-f3e1-4311-af6a-1c3fe4f6b6ba"
},
"journeyId": {
"type": "string",
"description": "The Id of the Journey",
"format": "uuid",
"example": "088f2d94-f2e1-4afb-b908-498a76ebf771"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdvReqStatusResponseDto"
},
"description": "The statuses of the Idv Requirements",
"nullable": true
}
},
"additionalProperties": false,
"description": "Contains all the information needed to store the status of the Idv Requirement"
},
"IdvReqStatusModelResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/IdvReqStatusModelResponseDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"IdvReqStatusResponseDto": {
"type": "object",
"properties": {
"requirementId": {
"type": "string",
"description": "The Id of the Requirement",
"format": "uuid",
"example": "580565ee-0700-4aec-854d-8cc9dbb58bc1"
},
"status": {
"type": "string",
"description": "The Status of the Idv Requirement",
"nullable": true,
"example": "Completed"
},
"ownershipAndControlDataKey": {
"type": "string",
"description": "The DataKey of the Requirement",
"nullable": true,
"example": "addAllUBOs"
},
"completedDate": {
"type": "string",
"description": "The date when the Requirement was set to 'Completed'",
"format": "date-time",
"nullable": true,
"example": null
},
"requirementName": {
"type": "string",
"description": "The Name of the Requirement",
"nullable": true,
"example": "Add All UBOs"
},
"idvMinimumPartyCount": {
"type": "integer",
"description": "The Minimum Idv Party Count needed to validate the Requirement",
"format": "int32",
"nullable": true,
"example": 2
},
"idvAllParties": {
"type": "boolean",
"description": "The attribute which specifies if all Related Parties that meet the criteria need to be Idv compliant",
"nullable": true,
"example": false
}
},
"additionalProperties": false,
"description": "Contains all the information needed to store the status of the Idv Requirement"
},
"IdvS3Object": {
"allOf": [
{
"$ref": "#/components/schemas/IdvBaseRequest"
},
{
"type": "object",
"properties": {
"docValidationResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProcessResults"
},
"nullable": true
},
"faceSimilarityResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MatchResults"
},
"nullable": true
},
"attempts": {
"type": "integer",
"format": "int32"
},
"livenessTestEnabled": {
"type": "boolean"
},
"processCompleted": {
"type": "boolean",
"readOnly": true
},
"processCompletedDate": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"reviewResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReviewResult"
},
"nullable": true
},
"documentTypeAccepted": {
"type": "boolean"
},
"userEvaluationResult": {
"allOf": [
{
"$ref": "#/components/schemas/UserValidationResult"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"ImageData": {
"type": "object",
"properties": {
"image": {
"type": "string",
"nullable": true
},
"format": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ImageDataExt": {
"allOf": [
{
"$ref": "#/components/schemas/ImageData"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"ImageQualityCheck": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/ImageQualityCheckType"
}
]
},
"result": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"featureType": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityFeatureType"
}
]
},
"areas": {
"allOf": [
{
"$ref": "#/components/schemas/AreaArray"
}
],
"nullable": true
},
"mean": {
"type": "number",
"format": "float"
},
"stdDev": {
"type": "number",
"format": "float"
},
"probability": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ImageQualityCheckList": {
"type": "object",
"properties": {
"result": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"list": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageQualityCheck"
},
"nullable": true
},
"count": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"ImageQualityCheckType": {
"enum": [
0,
1,
2,
3,
4,
5,
7,
8,
9,
10
],
"type": "integer",
"format": "int32"
},
"ImageQualityChecks": {
"type": "object",
"properties": {
"focus": {
"type": "integer",
"format": "int32"
},
"glare": {
"type": "integer",
"format": "int32"
},
"bounds": {
"type": "integer",
"format": "int32"
},
"resolution": {
"type": "integer",
"format": "int32"
},
"angle": {
"type": "integer",
"format": "int32"
},
"portraitPresence": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ImageQualityResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"imageQualityCheckList": {
"allOf": [
{
"$ref": "#/components/schemas/ImageQualityCheckList"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"ImageSource": {
"enum": [
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"format": "int32"
},
"Images": {
"type": "object",
"properties": {
"fieldCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"availableSourceCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"availableSourceList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImagesAvailableSource"
},
"nullable": true
},
"fieldList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImagesField"
},
"nullable": true
}
},
"additionalProperties": false
},
"ImagesAvailableSource": {
"type": "object",
"properties": {
"source": {
"allOf": [
{
"$ref": "#/components/schemas/Source"
}
]
},
"containerType": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ImagesData": {
"type": "object",
"properties": {
"faceImage": {
"type": "string",
"nullable": true
},
"documentFaceImage": {
"type": "string",
"nullable": true
},
"documentImage": {
"type": "string",
"nullable": true
},
"documentImages": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"signatureImage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ImagesField": {
"type": "object",
"properties": {
"fieldType": {
"allOf": [
{
"$ref": "#/components/schemas/GraphicFieldType"
}
]
},
"fieldName": {
"type": "string",
"nullable": true
},
"valueList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImagesFieldValue"
},
"nullable": true
},
"valueCount": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"ImagesFieldValue": {
"type": "object",
"properties": {
"source": {
"allOf": [
{
"$ref": "#/components/schemas/Source"
}
]
},
"lightIndex": {
"allOf": [
{
"$ref": "#/components/schemas/Light"
}
]
},
"value": {
"type": "string",
"nullable": true
},
"originalValue": {
"type": "string",
"nullable": true
},
"originalPageIndex": {
"type": "integer",
"format": "int32",
"nullable": true
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"containerType": {
"type": "integer",
"format": "int32"
},
"fieldRect": {
"allOf": [
{
"$ref": "#/components/schemas/RectangleCoordinates"
}
],
"nullable": true
},
"rfidOrigin": {
"allOf": [
{
"$ref": "#/components/schemas/RfidOrigin"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ImagesResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"images": {
"allOf": [
{
"$ref": "#/components/schemas/Images"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"InitiateIdvRequirementsValidationDto": {
"type": "object",
"properties": {
"entityId": {
"type": "string",
"description": "The UiD of the Entity",
"format": "uuid",
"example": "58e4b43a-a082-49a6-bf79-0cf8df2313c6"
},
"entityDraftId": {
"type": "string",
"description": "The UiD of the Entity Draft",
"format": "uuid",
"example": "24511767-4586-4b69-af43-c405ec6b154a"
},
"journeyId": {
"type": "string",
"description": "The UiD of the Journey",
"format": "uuid",
"example": "7a15bd4a-20f7-497f-b16a-a75d52c8fe01"
},
"taskId": {
"type": "string",
"description": "The UiD of the Journey",
"format": "uuid",
"example": "e205ea02-72c6-4aa6-9a10-804a3c78ccaf"
},
"entityType": {
"type": "string",
"description": "Entity Type",
"nullable": true,
"example": "Company"
},
"categories": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Categories to be used for Idv requirements validation",
"nullable": true
},
"jurisdictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VersionedJurisdictionDto"
},
"description": "Jurisdictions to be used for Idv requirements validation",
"nullable": true
},
"ruleSetId": {
"type": "string",
"description": "The ID of the Related Party Scoping Rule Set to scope the entity-in-scope lookup by, if any",
"format": "uuid",
"nullable": true,
"example": "b1e0a2a4-9b8b-4e2a-9f2a-0b7e2a4a2a4a"
}
},
"additionalProperties": false,
"description": "DTO representing initialization of Idv requirements validation business process"
},
"InitiateIdvRequirementsValidationDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/InitiateIdvRequirementsValidationDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"InitiateIdvRequirementsValidationResponseDto": {
"type": "object",
"properties": {
"businessProcessId": {
"type": "string",
"description": "The UiD of the initiated Idv requirements validation business process",
"format": "uuid",
"example": "24511767-4586-4b69-af43-c405ec6b154a"
}
},
"additionalProperties": false,
"description": "Response DTO representing initiated Idv requirements validation business process response"
},
"InitiateIdvRequirementsValidationResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/InitiateIdvRequirementsValidationResponseDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"InitiateVerificationDto": {
"type": "object",
"properties": {
"entityType": {
"type": "string",
"nullable": true
},
"entityId": {
"type": "string",
"nullable": true
},
"locale": {
"type": "string",
"nullable": true
},
"contextValues": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"InitiateVerificationDtoServiceRequest": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/InitiateVerificationDto"
}
],
"description": "The service request DTO"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"InitiateVerificationResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"url": {
"type": "string",
"nullable": true
},
"transactionId": {
"type": "string",
"nullable": true
},
"transactionUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"InitiateVerificationResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/InitiateVerificationResponseDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"LCID": {
"enum": [
0,
1025,
1026,
1027,
1028,
1029,
1030,
1031,
1032,
1033,
1034,
1035,
1036,
1037,
1038,
1039,
1040,
1041,
1042,
1043,
1044,
1045,
1046,
1047,
1048,
1049,
1050,
1051,
1052,
1053,
1054,
1055,
1056,
1057,
1058,
1059,
1060,
1061,
1062,
1063,
1064,
1065,
1066,
1067,
1068,
1069,
1071,
1078,
1079,
1080,
1081,
1082,
1086,
1087,
1088,
1089,
1090,
1091,
1092,
1093,
1094,
1095,
1096,
1097,
1098,
1099,
1100,
1101,
1102,
1103,
1104,
1107,
1108,
1109,
1110,
1111,
1113,
1114,
1115,
1118,
1120,
1121,
1123,
1125,
2049,
2052,
2055,
2057,
2058,
2060,
2064,
2067,
2068,
2070,
2074,
2077,
2092,
2110,
2115,
2117,
2137,
3073,
3076,
3079,
3081,
3082,
3084,
3098,
4096,
4097,
4100,
4103,
4105,
4106,
4108,
5121,
5124,
5127,
5129,
5130,
5132,
6145,
6153,
6154,
6156,
7169,
7177,
7178,
8193,
8201,
8202,
9217,
9225,
9226,
10000,
10001,
10002,
10003,
10004,
10011,
10012,
10241,
10249,
10250,
10560,
11265,
11273,
11274,
12289,
12297,
12298,
13313,
13321,
13322,
14337,
14346,
15361,
15370,
16385,
16394,
17418,
18442,
19466,
20490,
50001,
50002
],
"type": "integer",
"format": "int32"
},
"LexicalAnalysisResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"listVerifiedFields": {
"allOf": [
{
"$ref": "#/components/schemas/ListVerifiedFields"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"LicenseResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"license": {
"type": "string",
"format": "byte",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"Light": {
"enum": [
0,
2,
4,
6,
24,
128,
3072
],
"type": "integer",
"format": "int32"
},
"ListVerifiedFields": {
"type": "object",
"properties": {
"count": {
"type": "number",
"format": "double"
},
"pFieldMaps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VerifiedFieldMap"
},
"nullable": true
},
"pDateFormat": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"MDLResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"mdlParsedResponse": {
"type": "object",
"additionalProperties": { },
"nullable": true
}
},
"additionalProperties": false
}
]
},
"MRZDetectorResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"resultMRZDetector": {
"allOf": [
{
"$ref": "#/components/schemas/ResultMRZDetector"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"MRZPositionResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"mrzPosition": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentPosition"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"MRZRowsItem": {
"type": "object",
"properties": {
"length": {
"type": "integer",
"format": "int32"
},
"maxLength": {
"type": "integer",
"format": "int32"
},
"symbols": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Symbol"
},
"nullable": true
}
},
"additionalProperties": false
},
"MRZTestQuality": {
"type": "object",
"properties": {
"checK_SUMS": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"contrasT_PRINT": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"prinT_POSITION": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"staiN_MRZ": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"symbolS_PARAM": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"textuaL_FILLING": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"doC_FORMAT": {
"type": "integer",
"format": "int32"
},
"mrZ_FORMAT": {
"type": "integer",
"format": "int32"
},
"strCount": {
"type": "integer",
"format": "int32"
},
"strings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StringItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"MRZTestQualityResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"mrzTestQuality": {
"allOf": [
{
"$ref": "#/components/schemas/MRZTestQuality"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"MatchImageDetection": {
"type": "object",
"properties": {
"status": {
"allOf": [
{
"$ref": "#/components/schemas/FaceSDKResultCode"
}
]
},
"faces": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DetectionFace"
},
"nullable": true
},
"imageIndex": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"MatchImageResult": {
"type": "object",
"properties": {
"first": {
"allOf": [
{
"$ref": "#/components/schemas/ImageSource"
}
],
"nullable": true
},
"second": {
"allOf": [
{
"$ref": "#/components/schemas/ImageSource"
}
],
"nullable": true
},
"firstIndex": {
"type": "integer",
"format": "int32"
},
"firstFaceIndex": {
"type": "number",
"format": "double"
},
"secondIndex": {
"type": "integer",
"format": "int32"
},
"secondFaceIndex": {
"type": "number",
"format": "double"
},
"score": {
"type": "number",
"format": "double"
},
"similarity": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"MatchResponse": {
"type": "object",
"properties": {
"code": {
"allOf": [
{
"$ref": "#/components/schemas/FaceSDKResultCode"
}
]
},
"detections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MatchImageDetection"
},
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MatchImageResult"
},
"nullable": true
},
"metadata": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"MatchResponseWithImages": {
"type": "object",
"properties": {
"originaMatchResponse": {
"allOf": [
{
"$ref": "#/components/schemas/MatchResponse"
}
],
"nullable": true
},
"originalFaceImage": {
"type": "string",
"nullable": true
},
"croppedFaceImage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"MatchResults": {
"type": "object",
"properties": {
"matchResponse": {
"allOf": [
{
"$ref": "#/components/schemas/MatchResponseWithImages"
}
],
"nullable": true
},
"configurationVersion": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"MeasureCompletenessRequestDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The Id of the existing Idv Requirement Status Model",
"format": "uuid",
"example": "b3b8b5c8-809a-462a-834b-64206522daa9"
},
"journeyId": {
"type": "string",
"description": "The Id of the Journey",
"format": "uuid",
"example": "19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769"
},
"taskId": {
"type": "string",
"description": "The Id of the Task",
"format": "uuid",
"example": "d560c7bc-2e5d-449c-bd2a-07962fa2f755"
},
"entityId": {
"type": "string",
"description": "The Id of the Entity",
"format": "uuid",
"example": "315df981-38a0-4145-836b-8d22745887b6"
},
"entityDraftId": {
"type": "string",
"description": "The Id of the EntityDraft",
"format": "uuid",
"example": "ed1c2720-568b-4ac1-b481-b3c4c24025b1"
}
},
"additionalProperties": false,
"description": "Request DTO representing object used to measure the completeness of Ownership and Control Idv Requirements"
},
"MeasureCompletenessRequestDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/MeasureCompletenessRequestDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"MeasureCompletenessResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The Id of the Model",
"nullable": true,
"example": "fa8cb45d-ac78-4c4e-b701-ffcc2c9e79cf"
},
"journeyId": {
"type": "string",
"description": "The Id of the Journey",
"nullable": true,
"example": "19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769"
},
"entityId": {
"type": "string",
"description": "The Id of the Entity",
"nullable": true,
"example": "315df981-38a0-4145-836b-8d22745887b6"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeasureCompletenessStatusResponse"
},
"description": "The statuses of the Idv requirement",
"nullable": true
}
},
"additionalProperties": false,
"description": "Contains all the information needed to store the status of the Completeness response"
},
"MeasureCompletenessResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/MeasureCompletenessResponseDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"MeasureCompletenessStatusResponse": {
"type": "object",
"properties": {
"requirementId": {
"type": "string",
"description": "The Id of the Requirement",
"nullable": true,
"example": "8d9e92eb-d18e-4d4d-8971-7781ccc31c80"
},
"requirementName": {
"type": "string",
"description": "The name of the Requirement",
"nullable": true,
"example": "Add 2 Directors"
},
"status": {
"type": "string",
"description": "The status of the Requirement",
"nullable": true,
"example": "Completed"
},
"ownershipAndControlDataKey": {
"type": "string",
"description": "The OwnershipAndControl DataKey",
"nullable": true,
"example": "addTwoDirectors"
},
"completedDate": {
"type": "string",
"description": "The date at which the requirement was set to Complete",
"format": "date-time",
"nullable": true
},
"idvMinimumPartyCount": {
"type": "integer",
"description": "The Minimum Idv Party Count needed to validate the Requirement",
"format": "int32",
"nullable": true,
"example": 2
},
"idvAllParties": {
"type": "boolean",
"description": "The attribute which specifies if all Related Parties that meet the criteria need to be Idv compliant",
"nullable": true,
"example": false
}
},
"additionalProperties": false,
"description": "Contains all the information needed to store the status of the Completeness response"
},
"Message": {
"type": "object",
"properties": {
"pid": {
"allOf": [
{
"$ref": "#/components/schemas/PID"
}
],
"nullable": true
},
"uvci": {
"type": "string",
"nullable": true
},
"ve": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VEItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"OCRSecurityTextResult": {
"allOf": [
{
"$ref": "#/components/schemas/AuthenticityCheckResultItem"
},
{
"type": "object",
"properties": {
"criticalFlag": {
"allOf": [
{
"$ref": "#/components/schemas/Critical"
}
]
},
"lightType": {
"allOf": [
{
"$ref": "#/components/schemas/Light"
}
]
},
"etalonFieldType": {
"allOf": [
{
"$ref": "#/components/schemas/TextFieldType"
}
]
},
"etalonLightType": {
"allOf": [
{
"$ref": "#/components/schemas/Light"
}
]
},
"fieldRect": {
"allOf": [
{
"$ref": "#/components/schemas/RectangleCoordinates"
}
],
"nullable": true
},
"etalonResultType": {
"type": "integer",
"format": "int32"
},
"etalonFieldRect": {
"allOf": [
{
"$ref": "#/components/schemas/RectangleCoordinates"
}
],
"nullable": true
},
"securityTextResultOCR": {
"type": "string",
"nullable": true
},
"etalonResultOCR": {
"type": "string",
"nullable": true
},
"reserved1": {
"type": "integer",
"format": "int32",
"nullable": true
},
"reserved2": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"ObjectServiceResponse": {
"type": "object",
"properties": {
"data": {
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"OneCandidate": {
"type": "object",
"properties": {
"rfidPresence": {
"allOf": [
{
"$ref": "#/components/schemas/RfidLocation"
}
]
},
"documentName": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"p": {
"type": "number",
"format": "double"
},
"rotated180": {
"type": "integer",
"format": "int32"
},
"fdsidList": {
"allOf": [
{
"$ref": "#/components/schemas/FDSIDList"
}
],
"nullable": true
},
"necessaryLights": {
"type": "integer",
"format": "int32"
},
"checkAuthenticity": {
"type": "integer",
"format": "int32"
},
"uvExp": {
"type": "integer",
"format": "int32"
},
"authenticityNecessaryLights": {
"type": "integer",
"format": "int32"
},
"oviExp": {
"type": "number",
"format": "double"
},
"rotationAngle": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"OriginalSymbol": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int64"
},
"probability": {
"type": "integer",
"format": "int32"
},
"rect": {
"allOf": [
{
"$ref": "#/components/schemas/RectangleCoordinates"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"PArrayField": {
"type": "object",
"properties": {
"bcTextFieldType": {
"allOf": [
{
"$ref": "#/components/schemas/TextFieldType"
}
],
"nullable": true
},
"bcTypeDECODE": {
"allOf": [
{
"$ref": "#/components/schemas/BarcodeType"
}
]
},
"bcAngleDETECT": {
"type": "number",
"format": "float"
},
"bcCodeResult": {
"type": "integer",
"format": "int32"
},
"bcCountModule": {
"type": "integer",
"format": "int32"
},
"bcDataModule": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataModule"
},
"nullable": true
},
"bcPDF417INFO": {
"allOf": [
{
"$ref": "#/components/schemas/BcPDF417INFO"
}
],
"nullable": true
},
"bcROIDETECT": {
"allOf": [
{
"$ref": "#/components/schemas/BcROIDETECT"
}
],
"nullable": true
},
"bcTextDecoderTypes": {
"type": "integer",
"format": "int32",
"nullable": true
},
"bcTypeDETECT": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"PID": {
"type": "object",
"properties": {
"dob": {
"type": "string",
"nullable": true
},
"i": {
"type": "string",
"nullable": true
},
"n": {
"type": "string",
"nullable": true
},
"sex": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ParsedData": {
"type": "object",
"properties": {
"parsingNotifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ParsingNotificationCodes"
},
"nullable": true
}
},
"additionalProperties": false
},
"ParsingNotificationCodes": {
"enum": [
139272,
139273,
139274,
139277,
139278,
139279,
139280,
139281,
139282,
139283,
139284,
139285,
139286,
139287,
139288,
139289,
2415919105,
2415919106,
2415919107,
2415919108,
2415919109,
2415919110,
2415919112,
2415919118,
2415919119,
2415919120,
2415919121,
2415919127,
2415919136,
2415919137,
2415919138,
2415919139,
2415919140,
2415919141,
2415919142,
2415919152,
2415919153,
2415919154,
2415919155,
2415919360,
2415919361,
2415919362,
2415919363,
2415919364,
2415919365,
2415919366,
2415919367,
2415919368,
2415919369,
2415919370,
2415919371,
2415919372,
2415919373,
2415919374,
2415919375,
2415919376,
2415919377,
2415919378,
2415919381,
2415919382,
2415919383,
2415919384,
2415919385,
2415919386,
2415919387,
2415919388,
2415919389,
2415919390,
2415919391,
2415919520,
2415919521,
2415919536,
2415919537,
2415919538,
2415919552,
2415919560,
2415919568,
2415919576,
2415919616,
2415919617,
2415919618,
2415919619,
2415919620,
2415919621,
2415919622,
2415919623,
2415919624,
2415919625,
2415919626,
2415919627,
2415919628,
2415919629,
2415919630,
2415919631,
2415919632,
2415919633,
2415919634,
2415919635,
2415919636,
2415919637,
2415919638,
2415919639,
2415919640,
2415919641,
2415919642,
2415919643,
2415919644,
2415919645,
2415919646,
2415919647,
2415919648,
2415919649,
2415919650,
2415919651,
2415919652,
2415919653,
2415919654,
2415919656,
2415919657,
2415919658,
2415919659,
2415919660,
2415919661,
2415919662,
2415919663,
2415919665,
2415919666,
2415919667,
2415919668,
2415919669,
2415919670,
2415919671,
2415919672,
2415919673,
2415919674,
2415919675,
2415919676,
2415919677,
2415919678,
2415919679,
2415919680,
2415919681,
2415919682,
2415919683,
2415919684,
2415919685,
2415919686,
2415919687,
2415919688,
2415919689,
2415919690,
2415919691,
2415919692,
2415919693,
2415919694,
2415919695,
2415919696,
2415919697,
2415919698,
2415919699,
2415919700,
2415919872,
2415920128,
2415920129,
2415920130,
2415920131,
2415984640,
2416050176,
2416115712,
2416181248,
2416246784,
2416312320,
2416377856,
2416443392,
2416508928,
2416574464,
2416640000,
2416705536,
2416967680,
2417033216,
2417098752,
2417164288,
2417229824,
2417295360,
2417360896,
2417426432,
2417491968,
2417557504,
2417623040,
2432696320,
2432696321,
2432696322,
2432696323,
2432696324,
2432696325,
2432696326,
2432696327,
2432696328,
2432696329,
2432696330,
2432696331,
2432696332,
2432696333,
2432696334,
2432696576,
2432696577,
2432696578,
2432696579,
2432696580,
2432696581,
2432696582,
2432696583,
2432696584,
2432696585,
2432696586,
2432696587,
2432696588,
2432696589,
2432696590,
2432696591,
2432696592,
2432696593,
2432696594,
2432696833,
2432696834,
2432696835,
2432696836,
2432697088,
2449473813,
2449473814,
2449473815,
2449473816,
2449473817,
2449539072,
2449604608,
2449670144,
2449735680,
2449801232,
2449801248,
2449801264,
2449801265,
2449801266,
2449801280,
2449801281,
2449801282,
2449801283,
2449801284,
2449801285,
2449801286,
2449801287,
2449801288,
2449801289,
2449801290,
2449801291,
2449801292,
2449801293,
2449801294,
2449801295,
2449801296,
2449801297,
2449801298,
2449801312,
2449801313,
2449801314,
2449801315,
2449801316,
2449801328,
2449801329,
2449801330,
2449801331,
2449801344,
2449801345,
2449801346,
2449801347,
2449801348,
2449801349,
2449801350,
2449801351,
2449801360,
2449801361,
2449801362,
2449801363,
2449801364,
2449801365,
2449801366,
2449801367,
2449801368,
2449801369,
2449801370,
2449801371,
2449801372,
2449801373,
2449801374,
2449801375,
2449801376,
2449801377,
2449801378,
2449801379,
2449801380,
2449801381,
2449801382,
2449801392,
2449801408,
2449801424,
2449801425,
2449801426,
2449801427,
2449801440,
2449801441,
2449801442,
2449801443,
2449801444,
2449801445,
2449801446,
2449801447,
2449801448,
2449801449,
2449801450,
2449801451,
2449801452,
2449801453,
2449801454,
2449801456,
2449801457,
2449801458,
2449801459,
2449801460,
2449801461,
2449801462,
2449801463
],
"type": "integer",
"format": "int64"
},
"PhotoIdentResult": {
"allOf": [
{
"$ref": "#/components/schemas/AuthenticityCheckResultItem"
},
{
"type": "object",
"properties": {
"lightIndex": {
"allOf": [
{
"$ref": "#/components/schemas/Light"
}
]
},
"area": {
"allOf": [
{
"$ref": "#/components/schemas/RectangleCoordinates"
}
],
"nullable": true
},
"sourceImage": {
"allOf": [
{
"$ref": "#/components/schemas/ImageData"
}
],
"nullable": true
},
"resultImages": {
"allOf": [
{
"$ref": "#/components/schemas/RawImageContainerList"
}
],
"nullable": true
},
"fieldTypesCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"fieldTypesList": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"step": {
"type": "integer",
"format": "int32",
"nullable": true
},
"angle": {
"type": "integer",
"format": "int32",
"nullable": true
},
"reserved3": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"Point": {
"type": "object",
"properties": {
"x": {
"type": "integer",
"format": "int32"
},
"y": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"PointArray": {
"type": "object",
"properties": {
"pointsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Point"
},
"nullable": true
}
},
"additionalProperties": false
},
"PointsContainer": {
"type": "object",
"properties": {
"pointCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"pointsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Point"
},
"nullable": true
}
},
"additionalProperties": false
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"ProcessResponse": {
"type": "object",
"properties": {
"chipPage": {
"allOf": [
{
"$ref": "#/components/schemas/RfidLocation"
}
]
},
"processingFinished": {
"allOf": [
{
"$ref": "#/components/schemas/ProcessingStatus"
}
]
},
"coreLibResultCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"containerList": {
"allOf": [
{
"$ref": "#/components/schemas/ContainerList"
}
],
"nullable": true
},
"transactionInfo": {
"allOf": [
{
"$ref": "#/components/schemas/TransactionInfo"
}
],
"nullable": true
},
"log": {
"type": "string",
"nullable": true
},
"passBackObject": {
"type": "object",
"additionalProperties": { },
"nullable": true
},
"morePagesAvailable": {
"type": "integer",
"format": "int32"
},
"elapsedTime": {
"type": "integer",
"format": "int32"
},
"metadata": {
"type": "object",
"additionalProperties": { },
"nullable": true
}
},
"additionalProperties": false
},
"ProcessResults": {
"type": "object",
"properties": {
"processResponse": {
"allOf": [
{
"$ref": "#/components/schemas/ProcessResponse"
}
],
"nullable": true
},
"configurationVersion": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ProcessingStatus": {
"enum": [
0,
1,
2
],
"type": "integer",
"format": "int32"
},
"ProviderConfigurationDto": {
"type": "object",
"properties": {
"configuration": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"ProviderConfigurationDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ProviderConfigurationDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"RFIDDocVisualExtendedField": {
"allOf": [
{
"$ref": "#/components/schemas/VisualExtendedFieldItem"
},
{
"type": "object",
"properties": {
"originDG": {
"type": "integer",
"format": "int32"
},
"originDGTag": {
"type": "integer",
"format": "int32",
"nullable": true
},
"originTagEntry": {
"type": "number",
"format": "double"
},
"originEntryView": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"RFIDDocVisualExtendedInfo": {
"type": "object",
"properties": {
"nFields": {
"type": "number",
"format": "double"
},
"pArrayFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RFIDDocVisualExtendedField"
},
"nullable": true
}
},
"additionalProperties": false
},
"RFIDErrorCodes": {
"enum": [
1,
2,
2147508866,
2147508867,
2147509184,
2147509185,
2147510016,
2147510659,
2147510660,
2147510661,
2147510912,
2147510914,
2147510920,
2147511040,
2147549185,
2147549186,
2147549188,
2147549189,
2147549190,
2147549191,
2147549192,
2147549193,
2147549194,
2147549195,
2147549196,
2147614720,
2147614721,
2147614722,
2147614723,
2147614724,
2147614725,
2147614726,
2147614736,
2148557760,
2197815296,
2197815297,
2197815298,
2197815312,
2197815313,
2197815314,
2197815315,
2197815316,
2197815317,
2197815318,
2197815319,
2197815320,
2197815321,
2197815322,
2197815323,
2197815324,
2197815328,
2197815329,
2197815330,
2197815331,
2197815332,
2197815333,
2197815334,
2197815335,
2197815336,
2197815337,
2197815338,
2197815344,
2197815345,
2197815360,
2197815361,
2197815362,
2197815376,
2197815377,
2197815378,
2197815392,
2197880832,
2197946368,
2198011904,
2198077440,
2198142976,
2198208512,
2198274048,
2198339584,
2214592512,
2214658048,
2214723584,
2214789120,
2214854656,
2214920192,
2214985728,
2215051264,
2215116800,
2215182336,
2215247872,
2215313408,
2215378944,
2215444480,
2215510016,
2215575552,
2248146944,
2248146945,
2248147200,
2248147201,
2248147202,
2248147203,
2248147456,
2248147457,
2248147458,
2248147459,
2248147460,
2248147712,
2248147713,
2248147714,
2248147715,
2248147716,
2248147717,
2248147718,
2248147719,
2248147720,
2248147721,
4294967295
],
"type": "integer",
"format": "int64"
},
"RFIDGraphicsInfoResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"tOriginalRFIDGraphicsInfo": {
"allOf": [
{
"$ref": "#/components/schemas/TOriginalRFIDGraphicsInfo"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"RFIDTextDataResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"docVisualExtendedInfo": {
"allOf": [
{
"$ref": "#/components/schemas/RFIDDocVisualExtendedInfo"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"RawImageContainerList": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageData"
},
"nullable": true
}
},
"additionalProperties": false
},
"RectangleCoordinates": {
"type": "object",
"properties": {
"left": {
"type": "integer",
"format": "int32"
},
"top": {
"type": "integer",
"format": "int32"
},
"right": {
"type": "integer",
"format": "int32"
},
"bottom": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"Result": {
"enum": [
1,
3,
5,
6,
7,
8,
9,
15,
16,
17,
18,
19,
20,
26,
30,
32,
33,
34,
35,
36,
37,
38,
39,
49,
50,
61,
62,
73,
85,
87,
97,
101,
102,
103,
104,
105,
109,
121,
124,
125
],
"type": "integer",
"format": "int32"
},
"ResultItem": {
"type": "object",
"properties": {
"resultType": {
"allOf": [
{
"$ref": "#/components/schemas/Result"
}
]
},
"bufLength": {
"type": "integer",
"format": "int32",
"nullable": true
},
"light": {
"type": "integer",
"format": "int32",
"nullable": true
},
"listIdx": {
"type": "integer",
"format": "int32",
"nullable": true
},
"pageIdx": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"ResultMRZDetector": {
"type": "object",
"properties": {
"mrzFormat": {
"type": "integer",
"format": "int32"
},
"mrzRows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MRZRowsItem"
},
"nullable": true
},
"mrzRowsNum": {
"type": "integer",
"format": "int32"
},
"boundingQuadrangle": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"nullable": true
}
},
"additionalProperties": false
},
"Results": {
"type": "object",
"properties": {
"transactionDate": {
"type": "string",
"format": "date-time"
},
"facialComparisonResult": {
"type": "integer",
"format": "int32"
},
"documentLivenessCheckResult": {
"type": "integer",
"format": "int32"
},
"imageQualityCheckResult": {
"type": "integer",
"format": "int32"
},
"documentVerificationResult": {
"type": "integer",
"format": "int32"
},
"documentMrzVerification": {
"type": "integer",
"format": "int32"
},
"documentTextFields": {
"type": "integer",
"format": "int32"
},
"documentTypeIdentified": {
"type": "integer",
"format": "int32"
},
"documentSecurityCheckResult": {
"type": "integer",
"format": "int32"
},
"documentExpirationCheckResult": {
"type": "integer",
"format": "int32"
},
"overallStatus": {
"type": "integer",
"format": "int32"
},
"documentTypeAccepted": {
"type": "boolean"
},
"attempts": {
"type": "integer",
"format": "int32"
},
"startedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"imageQualityChecks": {
"allOf": [
{
"$ref": "#/components/schemas/ImageQualityChecks"
}
],
"nullable": true
},
"documentLivenessChecks": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentLivenessChecks"
}
],
"nullable": true
},
"documentVerificationChecks": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentVerificationChecks"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ReviewResult": {
"allOf": [
{
"$ref": "#/components/schemas/ReviewResultBase"
},
{
"type": "object",
"properties": {
"userId": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"ReviewResultBase": {
"type": "object",
"properties": {
"result": {
"type": "boolean"
},
"reason": {
"type": "string",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
},
"reviewDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"RfidAChip": {
"enum": [
0,
1,
2,
3,
4,
5
],
"type": "integer",
"format": "int32"
},
"RfidAccessControlInfo": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/RfidAccessControlProcedureType"
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/RFIDErrorCodes"
}
]
},
"activeOptionIdx": {
"type": "number",
"format": "double",
"nullable": true
},
"notifications": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"nullable": true
},
"accessControlOptions": {
"type": "array",
"items": { },
"nullable": true
}
},
"additionalProperties": false
},
"RfidAccessControlProcedureType": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
10,
11
],
"type": "integer",
"format": "int32"
},
"RfidAccessKey": {
"type": "object",
"properties": {
"keyType": {
"allOf": [
{
"$ref": "#/components/schemas/RfidPasswordType"
}
]
},
"accessType": {
"allOf": [
{
"$ref": "#/components/schemas/RfidAccessControlProcedureType"
}
]
},
"accessKey": {
"type": "string",
"nullable": true
},
"checkFullKeyMatching": {
"type": "boolean"
}
},
"additionalProperties": false
},
"RfidApplication": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/RfidApplicationType"
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/RFIDErrorCodes"
}
]
},
"applicationID": {
"type": "string",
"nullable": true
},
"varVersion": {
"type": "string",
"nullable": true
},
"unicodeVersion": {
"type": "string",
"nullable": true
},
"dataHashAlgorithm": {
"type": "string",
"nullable": true
},
"files": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RfidDataFile"
},
"nullable": true
}
},
"additionalProperties": false
},
"RfidApplicationType": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
],
"type": "integer",
"format": "int32"
},
"RfidAttributeData": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"data": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RfidAttributeName": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"value": {
"allOf": [
{
"$ref": "#/components/schemas/TrfFtString"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"RfidAuthenticationProcedureType": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"format": "int32"
},
"RfidBaudRate": {
"enum": [
0,
1,
2,
4,
8,
16,
32,
64
],
"type": "integer",
"format": "int32"
},
"RfidCardPropertiesExt": {
"type": "object",
"properties": {
"rfidType": {
"allOf": [
{
"$ref": "#/components/schemas/RfidType"
}
]
},
"chipTypeA": {
"allOf": [
{
"$ref": "#/components/schemas/RfidAChip"
}
]
},
"bitRateS": {
"allOf": [
{
"$ref": "#/components/schemas/RfidBaudRate"
}
]
},
"bitRateR": {
"allOf": [
{
"$ref": "#/components/schemas/RfidBaudRate"
}
]
},
"baudrate1": {
"type": "string",
"nullable": true
},
"baudrate2": {
"type": "string",
"nullable": true
},
"support4": {
"type": "boolean"
},
"supportMifare": {
"type": "boolean"
},
"mifareMemory": {
"type": "number",
"format": "double"
},
"uid": {
"type": "string",
"nullable": true
},
"atQ_A": {
"nullable": true
},
"sak": {
"nullable": true
},
"atQ_B": {
"nullable": true
},
"atr": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RfidCertificateEx": {
"type": "object",
"properties": {
"origin": {
"allOf": [
{
"$ref": "#/components/schemas/RfidCertificateOrigin"
}
]
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/RfidCertificateType"
}
]
},
"paStatus": {
"allOf": [
{
"$ref": "#/components/schemas/RFIDErrorCodes"
}
]
},
"varVersion": {
"type": "number",
"format": "double"
},
"serialNumber": {
"type": "string",
"nullable": true
},
"signatureAlgorithm": {
"type": "string",
"nullable": true
},
"issuer": {
"allOf": [
{
"$ref": "#/components/schemas/RfidDistinguishedName"
}
],
"nullable": true
},
"validity": {
"allOf": [
{
"$ref": "#/components/schemas/RfidValidity"
}
],
"nullable": true
},
"subject": {
"allOf": [
{
"$ref": "#/components/schemas/RfidDistinguishedName"
}
],
"nullable": true
},
"subjectPKAlgorithm": {
"type": "string",
"nullable": true
},
"extensions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RfidPkiExtension"
},
"nullable": true
},
"notifications": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"nullable": true
},
"fileName": {
"allOf": [
{
"$ref": "#/components/schemas/TrfFtString"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"RfidCertificateOrigin": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
],
"type": "integer",
"format": "int32"
},
"RfidCertificateType": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13
],
"type": "integer",
"format": "int32"
},
"RfidDG1": {
"type": "object",
"properties": {
"documentID": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentFormat"
}
]
},
"type": {
"type": "integer",
"format": "int32"
},
"documentType": {
"type": "string",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"holder": {
"type": "string",
"nullable": true
},
"documentNumber": {
"type": "string",
"nullable": true
},
"checkDigitDocumentNumber": {
"type": "number",
"format": "double"
},
"nationality": {
"type": "string",
"nullable": true
},
"birthday": {
"type": "string",
"nullable": true
},
"checkDigitBirthday": {
"type": "number",
"format": "double"
},
"sex": {
"type": "string",
"nullable": true
},
"expiryDate": {
"type": "string",
"nullable": true
},
"checkDigitExpiryDate": {
"type": "number",
"format": "double"
},
"optionalData": {
"type": "string",
"nullable": true
},
"checkDigitOptionalData": {
"type": "number",
"format": "double"
},
"checkDigitComposite": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"RfidDataFile": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/RfidDataFileType"
}
]
},
"readingStatus": {
"allOf": [
{
"$ref": "#/components/schemas/RFIDErrorCodes"
}
]
},
"paStatus": {
"allOf": [
{
"$ref": "#/components/schemas/RFIDErrorCodes"
}
],
"nullable": true
},
"fileID": {
"type": "string",
"nullable": true
},
"fileData": {
"allOf": [
{
"$ref": "#/components/schemas/TrfFtBytes"
}
],
"nullable": true
},
"readingTime": {
"type": "number",
"format": "double",
"nullable": true
},
"notifications": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"nullable": true
},
"docFieldsText": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TextFieldType"
},
"nullable": true
},
"docFieldsGraphics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphicFieldType"
},
"nullable": true
},
"docFieldsOriginals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphicFieldType"
},
"nullable": true
},
"parsedData": {
"allOf": [
{
"$ref": "#/components/schemas/ParsedData"
}
],
"nullable": true
},
"securityObjectCertificates": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityObjectCertificates"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"RfidDataFileType": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
57,
58,
62,
63,
64,
101,
102,
103,
104,
105,
106,
107,
108,
109,
110,
111,
112,
113,
114,
115,
116,
117,
118,
119,
120,
121,
122,
150,
151,
152,
153,
154,
155,
156,
157,
158,
159,
160,
161,
162,
163,
164,
165,
166,
167,
200,
201,
202,
300,
301,
302,
400,
401,
500,
501,
600,
601,
602,
603,
604,
700,
701,
702,
703,
704,
710,
711,
712,
713,
714,
715,
800,
832,
900,
901,
902,
1000
],
"type": "integer",
"format": "int32"
},
"RfidDistinguishedName": {
"type": "object",
"properties": {
"data": {
"type": "string",
"nullable": true
},
"friendlyName": {
"allOf": [
{
"$ref": "#/components/schemas/TrfFtString"
}
],
"nullable": true
},
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RfidAttributeName"
},
"nullable": true
}
},
"additionalProperties": false
},
"RfidLocation": {
"enum": [
0,
1,
2
],
"type": "integer",
"format": "int32"
},
"RfidOrigin": {
"type": "object",
"properties": {
"dg": {
"type": "integer",
"format": "int32"
},
"dgTag": {
"type": "integer",
"format": "int32"
},
"tagEntry": {
"type": "integer",
"format": "int32"
},
"entryView": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"RfidPasswordType": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"format": "int32"
},
"RfidPkiExtension": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"data": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RfidRawData": {
"type": "object",
"properties": {
"data": {
"type": "string",
"nullable": true
},
"fieldType": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"RfidSecurityObject": {
"type": "object",
"properties": {
"varVersion": {
"type": "number",
"format": "double"
},
"objectType": {
"type": "string",
"nullable": true
},
"fileReference": {
"type": "number",
"format": "double"
},
"notifications": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"nullable": true
},
"signerInfos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RfidSignerInfoEx"
},
"nullable": true
}
},
"additionalProperties": false
},
"RfidSessionData": {
"type": "object",
"properties": {
"extLeSupport": {
"allOf": [
{
"$ref": "#/components/schemas/RFIDErrorCodes"
}
]
},
"sessionProcedure": {
"allOf": [
{
"$ref": "#/components/schemas/RfidAuthenticationProcedureType"
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
],
"nullable": true
},
"virtualMode": {
"type": "boolean",
"nullable": true
},
"sdkVersion": {
"type": "string",
"nullable": true
},
"driverVersion": {
"type": "string",
"nullable": true
},
"firmwareVersion": {
"type": "string",
"nullable": true
},
"applications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RfidApplication"
},
"nullable": true
},
"accessControls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RfidAccessControlInfo"
},
"nullable": true
},
"cardProperties": {
"allOf": [
{
"$ref": "#/components/schemas/RfidCardPropertiesExt"
}
],
"nullable": true
},
"processTime": {
"type": "number",
"format": "double"
},
"rootFiles": {
"type": "array",
"items": { },
"nullable": true
},
"totalBytesSent": {
"type": "number",
"format": "double"
},
"totalBytesReceived": {
"type": "number",
"format": "double"
},
"sessionKey": {
"allOf": [
{
"$ref": "#/components/schemas/RfidAccessKey"
}
],
"nullable": true
},
"sessionTerminal": {
"allOf": [
{
"$ref": "#/components/schemas/RfidTerminal"
}
],
"nullable": true
},
"securityObjects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RfidSecurityObject"
},
"nullable": true
}
},
"additionalProperties": false
},
"RfidSignerInfoEx": {
"type": "object",
"properties": {
"paStatus": {
"allOf": [
{
"$ref": "#/components/schemas/RFIDErrorCodes"
}
]
},
"varVersion": {
"type": "number",
"format": "double"
},
"issuer": {
"allOf": [
{
"$ref": "#/components/schemas/RfidDistinguishedName"
}
],
"nullable": true
},
"serialNumber": {
"allOf": [
{
"$ref": "#/components/schemas/TrfFtBytes"
}
],
"nullable": true
},
"subjectKeyIdentifier": {
"allOf": [
{
"$ref": "#/components/schemas/TrfFtBytes"
}
],
"nullable": true
},
"digestAlgorithm": {
"type": "string",
"nullable": true
},
"signedAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RfidAttributeData"
},
"nullable": true
},
"signatureAlgorithm": {
"type": "string",
"nullable": true
},
"signature": {
"allOf": [
{
"$ref": "#/components/schemas/TrfFtBytes"
}
],
"nullable": true
},
"certificateChain": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RfidCertificateEx"
},
"nullable": true
},
"dataToHash": {
"type": "string",
"nullable": true
},
"notifications": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"nullable": true
}
},
"additionalProperties": false
},
"RfidTerminal": {
"type": "object",
"properties": {
"termType": {
"allOf": [
{
"$ref": "#/components/schemas/RfidTerminalType"
}
]
},
"authReq": {
"type": "number",
"format": "double"
},
"authReq2": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"RfidTerminalType": {
"enum": [
0,
1,
2,
3,
4
],
"type": "integer",
"format": "int32"
},
"RfidType": {
"enum": [
0,
1,
2
],
"type": "integer",
"format": "int32"
},
"RfidValidity": {
"type": "object",
"properties": {
"notBefore": {
"allOf": [
{
"$ref": "#/components/schemas/TrfFtString"
}
],
"nullable": true
},
"notAfter": {
"allOf": [
{
"$ref": "#/components/schemas/TrfFtString"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"SaveProviderConfigurationResponseDto": {
"type": "object",
"properties": {
"status": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"SaveProviderConfigurationResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/SaveProviderConfigurationResponseDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"SecurityFeatureResult": {
"allOf": [
{
"$ref": "#/components/schemas/AuthenticityCheckResultItem"
},
{
"type": "object",
"properties": {
"elementType": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityFeatureType"
}
]
},
"visibility": {
"allOf": [
{
"$ref": "#/components/schemas/Visibility"
}
]
},
"criticalFlag": {
"allOf": [
{
"$ref": "#/components/schemas/Critical"
}
]
},
"elementRect": {
"allOf": [
{
"$ref": "#/components/schemas/RectangleCoordinates"
}
],
"nullable": true
},
"areaList": {
"allOf": [
{
"$ref": "#/components/schemas/AreaContainer"
}
],
"nullable": true
},
"reserved2": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"SecurityFeatureType": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62
],
"type": "integer",
"format": "int32"
},
"SecurityObjectCertificates": {
"type": "object",
"properties": {
"certificateData": {
"allOf": [
{
"$ref": "#/components/schemas/CertificateData"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "string",
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"ServiceResponseMessage": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The message",
"nullable": true,
"example": "Success"
},
"type": {
"type": "string",
"description": "Type of the message\nOne of Info, Warning, Error, Forbidden",
"nullable": true,
"example": "Info"
},
"errorCode": {
"type": "string",
"description": "Error Code",
"nullable": true,
"example": "INTERNAL_SERVER_ERROR"
}
},
"additionalProperties": false,
"description": "The message associated to the service response"
},
"SignScopingRuleSetVersionResponseDto": {
"type": "object",
"properties": {
"scopingRuleSetId": {
"type": "string",
"description": "The UiD of the scoping rule set",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"versionNumber": {
"type": "integer",
"description": "The number of the version that has been signed",
"format": "int32",
"example": 2
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
],
"description": "The new version status",
"example": "Rejected"
}
},
"additionalProperties": false,
"description": "Sign scoping rule set response contains the new version status"
},
"SignScopingRuleSetVersionResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/SignScopingRuleSetVersionResponseDto"
}
],
"description": "Sign scoping rule set response contains the new version status",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"SigneeDto": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"nullable": true
},
"successor": {
"allOf": [
{
"$ref": "#/components/schemas/Approver"
}
],
"nullable": true
},
"action": {
"allOf": [
{
"$ref": "#/components/schemas/ApproveAction"
}
],
"nullable": true
},
"hasProcessedRequest": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Defines a version Signee"
},
"SingleIdvReqStatusRequestDto": {
"required": [
"requirementId"
],
"type": "object",
"properties": {
"requirementId": {
"minLength": 1,
"type": "string",
"description": "The Id of the Requirement",
"format": "uuid",
"example": "580565ee-0700-4aec-854d-8cc9dbb58bc1"
},
"status": {
"type": "string",
"description": "The status of the Idv Requirement",
"nullable": true,
"example": "Completed"
},
"ownershipAndControlDataKey": {
"type": "string",
"description": "The DataKey of the Requirement",
"nullable": true,
"example": "addAllUBOs"
},
"requirementName": {
"type": "string",
"description": "The Name of the Requirement",
"nullable": true,
"example": "Add All UBOs"
},
"idvMinimumPartyCount": {
"type": "integer",
"description": "The Minimum Idv Party Count needed to validate the Requirement",
"format": "int32",
"nullable": true,
"example": 2
},
"idvAllParties": {
"type": "boolean",
"description": "The attribute which specifies if all Related Parties that meet the criteria need to be Idv compliant",
"nullable": true,
"example": false
}
},
"additionalProperties": false,
"description": "Contains the data for updating an Idv Requirement Status"
},
"SingleIdvReqStatusRequestDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/SingleIdvReqStatusRequestDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"Source": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8
],
"type": "integer",
"format": "int32"
},
"SourceValidity": {
"type": "object",
"properties": {
"source": {
"allOf": [
{
"$ref": "#/components/schemas/Source"
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
}
},
"additionalProperties": false
},
"Status": {
"type": "object",
"properties": {
"overallStatus": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"optical": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"portrait": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"rfid": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"stopList": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"age": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"mdl": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"detailsRFID": {
"allOf": [
{
"$ref": "#/components/schemas/DetailsRFID"
}
],
"nullable": true
},
"detailsOptical": {
"allOf": [
{
"$ref": "#/components/schemas/DetailsOptical"
}
],
"nullable": true
},
"detailsAge": {
"allOf": [
{
"$ref": "#/components/schemas/DetailsAge"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"StatusResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"status": {
"allOf": [
{
"$ref": "#/components/schemas/Status"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"StringConditionalValueDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the condition",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"name": {
"type": "string",
"description": "The name of the condition",
"nullable": true,
"example": "Company-type only"
},
"description": {
"type": "string",
"description": "The description of the condition",
"nullable": true,
"example": "Applicable only when EntityType=Company"
},
"logicalOperation": {
"type": "string",
"description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection",
"nullable": true,
"example": "AND"
},
"operands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDefinitionDto"
},
"description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto",
"nullable": true
},
"value": {
"type": "string",
"description": "Value that should be returned when conditions are met",
"nullable": true,
"example": "Relationship Manager"
},
"priority": {
"type": "integer",
"description": "Priority of the value in case when multiple conditional values are evaluated",
"format": "int32",
"example": 1
}
},
"additionalProperties": false
},
"StringItem": {
"type": "object",
"properties": {
"alignmenT_SYMBOLS_IN_STRING": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"checK_SUMS": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"stringS_DISTANCE": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"stringS_INTERVAL": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"strinG_FILLING": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"stringS_POSITION": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
],
"nullable": true
},
"symbolS_PARAM": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"errorPOSITION": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorCoordinates"
}
],
"nullable": true
},
"fieldCount": {
"type": "integer",
"format": "int32"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldItem"
},
"nullable": true
},
"sizeErrorALIGNMENT": {
"type": "number",
"format": "double"
},
"sizeErrorDISTANCE": {
"type": "number",
"format": "double"
},
"sizeErrorINTERVAL": {
"type": "number",
"format": "double"
},
"stringAngle": {
"type": "number",
"format": "double"
},
"stringBorders": {
"allOf": [
{
"$ref": "#/components/schemas/RectangleCoordinates"
}
],
"nullable": true
},
"symbolsCount": {
"type": "integer",
"format": "int32"
},
"symbolsEstimations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SymbolEstimationItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"StringRecognitionResult": {
"type": "object",
"properties": {
"symbolsCount": {
"type": "number",
"format": "double"
},
"stringResult": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SymbolRecognitionResult"
},
"nullable": true
},
"bufLength": {
"type": "number",
"format": "double",
"nullable": true
},
"bufText": {
"type": "string",
"nullable": true
},
"reserved": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"StringServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "string",
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"Symbol": {
"type": "object",
"properties": {
"boundingRect": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"SymbolCandidate": {
"type": "object",
"properties": {
"symbolCode": {
"type": "integer",
"format": "int64"
},
"symbolProbability": {
"type": "integer",
"format": "int32"
},
"class": {
"type": "integer",
"format": "int32",
"nullable": true
},
"subClass": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"SymbolEstimationItem": {
"type": "object",
"properties": {
"alignmenT_NEAREST_SYMBOLS": {
"type": "integer",
"format": "int32"
},
"contrasT_PRINT": {
"type": "integer",
"format": "int32"
},
"contrasT_SYMBOL": {
"type": "integer",
"format": "int32"
},
"charSymbol": {
"type": "integer",
"format": "int32"
},
"edge": {
"type": "integer",
"format": "int32"
},
"emptiness": {
"type": "integer",
"format": "int32"
},
"stain": {
"type": "integer",
"format": "int32"
},
"symbolS_INTERVAL": {
"type": "integer",
"format": "int32"
},
"symboL_PARAM": {
"type": "integer",
"format": "int32"
},
"symboL_SIZE": {
"type": "integer",
"format": "int32"
},
"sizeErrorAlignWithNext": {
"type": "number",
"format": "double"
},
"sizeErrorAlignWithPrev": {
"type": "number",
"format": "double"
},
"sizeErrorIntervWithNext": {
"type": "number",
"format": "double"
},
"sizeErrorIntervWithPrev": {
"type": "number",
"format": "double"
},
"sizeErrorSymbolHeight": {
"type": "number",
"format": "double"
},
"sizeErrorSymbolWidth": {
"type": "number",
"format": "double"
},
"symbolBounds": {
"allOf": [
{
"$ref": "#/components/schemas/RectangleCoordinates"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"SymbolRecognitionResult": {
"type": "object",
"properties": {
"symbolRect": {
"allOf": [
{
"$ref": "#/components/schemas/RectangleCoordinates"
}
],
"nullable": true
},
"candidatesCount": {
"type": "number",
"format": "double"
},
"listOfCandidates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SymbolCandidate"
},
"nullable": true
},
"baseLineBottom": {
"type": "integer",
"format": "int32",
"nullable": true
},
"baseLineTop": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"T": {
"type": "object",
"additionalProperties": false
},
"TDocBinaryInfo": {
"type": "object",
"properties": {
"rfiD_BINARY_DATA": {
"allOf": [
{
"$ref": "#/components/schemas/BinaryData"
}
],
"nullable": true
},
"rfiD_RAW_DATA": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RfidRawData"
},
"nullable": true
}
},
"additionalProperties": false
},
"TOriginalRFIDGraphicsInfo": {
"type": "object",
"properties": {
"rfiD_ORIGINAL_GRAPH_DATA": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GraphData"
},
"nullable": true
}
},
"additionalProperties": false
},
"Text": {
"type": "object",
"properties": {
"status": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"validityStatus": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"comparisonStatus": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"dateFormat": {
"type": "string",
"nullable": true
},
"fieldList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TextField"
},
"nullable": true
},
"availableSourceList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TextAvailableSource"
},
"nullable": true
}
},
"additionalProperties": false
},
"TextAvailableSource": {
"type": "object",
"properties": {
"source": {
"allOf": [
{
"$ref": "#/components/schemas/Source"
}
]
},
"validityStatus": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"containerType": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TextDataResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"docVisualExtendedInfo": {
"allOf": [
{
"$ref": "#/components/schemas/DocVisualExtendedInfo"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"TextField": {
"type": "object",
"properties": {
"fieldType": {
"allOf": [
{
"$ref": "#/components/schemas/TextFieldType"
}
]
},
"lcid": {
"allOf": [
{
"$ref": "#/components/schemas/LCID"
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"validityStatus": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"comparisonStatus": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"fieldName": {
"type": "string",
"nullable": true
},
"lcidName": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
},
"valueList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TextFieldValue"
},
"nullable": true
},
"validityList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SourceValidity"
},
"nullable": true
},
"comparisonList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CrossSourceValueComparison"
},
"nullable": true
}
},
"additionalProperties": false
},
"TextFieldType": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
82,
83,
84,
85,
86,
87,
88,
89,
90,
91,
92,
93,
94,
95,
96,
97,
98,
99,
100,
101,
102,
103,
104,
105,
106,
107,
108,
109,
110,
111,
112,
113,
114,
115,
116,
117,
118,
119,
120,
121,
122,
123,
124,
125,
126,
127,
128,
129,
130,
131,
132,
133,
134,
135,
136,
137,
138,
139,
140,
141,
142,
143,
144,
145,
146,
147,
148,
149,
150,
151,
152,
153,
154,
155,
156,
157,
158,
159,
160,
161,
162,
163,
164,
165,
166,
167,
168,
169,
170,
171,
172,
173,
174,
175,
176,
177,
178,
179,
180,
181,
182,
183,
184,
185,
186,
187,
188,
189,
190,
191,
192,
193,
194,
195,
196,
197,
198,
199,
200,
220,
221,
251,
252,
253,
254,
255,
256,
257,
258,
259,
260,
261,
262,
263,
264,
265,
266,
267,
268,
269,
270,
271,
272,
273,
274,
275,
276,
277,
278,
279,
280,
281,
282,
283,
284,
285,
286,
287,
288,
289,
290,
291,
292,
293,
294,
295,
296,
297,
298,
299,
300,
301,
302,
303,
304,
305,
306,
307,
308,
309,
310,
311,
312,
313,
314,
315,
316,
317,
318,
319,
320,
321,
322,
323,
324,
325,
326,
327,
328,
329,
330,
331,
332,
333,
334,
335,
336,
337,
338,
339,
340,
341,
342,
343,
344,
345,
346,
347,
348,
349,
350,
351,
352,
353,
354,
355,
356,
357,
358,
359,
360,
361,
362,
363,
364,
365,
366,
367,
368,
369,
370,
371,
372,
373,
374,
375,
376,
377,
378,
379,
380,
381,
382,
383,
384,
385,
386,
387,
388,
389,
390,
391,
392,
393,
394,
395,
396,
397,
398,
399,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
411,
412,
413,
414,
415,
416,
417,
418,
419,
420,
421,
422,
423,
424,
425,
426,
427,
428,
429,
430,
431,
432,
433,
434,
435,
436,
437,
438,
439,
440,
441,
442,
443,
444,
445,
446,
447,
448,
449,
450,
451,
452,
453,
454,
455,
456,
457,
458,
459,
460,
461,
462,
463,
464,
465,
466,
467,
468,
469,
470,
471,
472,
473,
474,
475,
476,
477,
478,
479,
480,
481,
482,
483,
484,
485,
486,
487,
488,
489,
490,
491,
492,
493,
494,
495,
496,
497,
498,
499,
500,
501,
502,
503,
504,
505,
506,
507,
508,
509,
510,
511,
512,
513,
514,
515,
516,
517,
518,
519,
520,
521,
522,
523,
524,
525,
526,
527,
528,
529,
530,
531,
532,
533,
534,
535,
536,
537,
538,
539,
540,
541,
542,
543,
544,
545,
546,
547,
548,
549,
550,
551,
552,
553,
554,
555,
556,
557,
558,
559,
560,
561,
562,
563,
564,
565,
566,
567,
568,
569,
570,
571,
572,
573,
574,
575,
576,
577,
578,
579,
580,
581,
582,
583,
584,
585,
586,
587,
588,
589,
590,
591,
592,
593,
594,
595,
596,
597,
598,
599,
600,
601,
602,
603,
604,
605,
606,
607,
608,
609,
610,
611,
612,
613,
614,
615,
616,
617,
618,
619,
620,
621,
622,
623,
624,
625,
626,
627,
628,
629,
630,
631,
632,
633,
634,
635,
636,
637,
638,
639,
640,
641,
642,
643,
644,
645,
646,
647,
648,
649,
650,
651,
652,
653,
654,
655,
656,
657,
658,
659,
660,
661,
662,
663,
664,
665,
666,
667,
668,
669,
670,
671,
672,
673,
674,
675,
676,
677,
678,
679,
680,
681,
682,
683,
684,
685,
686,
687,
688,
689,
690,
691,
692,
693,
694,
695,
696,
697,
698,
699,
700,
701,
702,
703,
704,
705
],
"type": "integer",
"format": "int32"
},
"TextFieldValue": {
"type": "object",
"properties": {
"source": {
"allOf": [
{
"$ref": "#/components/schemas/Source"
}
]
},
"originalValidity": {
"allOf": [
{
"$ref": "#/components/schemas/CheckResult"
}
]
},
"value": {
"type": "string",
"nullable": true
},
"originalValue": {
"type": "string",
"nullable": true
},
"originalSymbols": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OriginalSymbol"
},
"nullable": true
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"probability": {
"type": "integer",
"format": "int32"
},
"fieldRect": {
"allOf": [
{
"$ref": "#/components/schemas/RectangleCoordinates"
}
],
"nullable": true
},
"rfidOrigin": {
"allOf": [
{
"$ref": "#/components/schemas/RfidOrigin"
}
],
"nullable": true
},
"containerType": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TextResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"text": {
"allOf": [
{
"$ref": "#/components/schemas/Text"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"TransactionInfo": {
"type": "object",
"properties": {
"computerName": {
"type": "string",
"nullable": true
},
"dateTime": {
"type": "string",
"nullable": true
},
"documentsDatabase": {
"allOf": [
{
"$ref": "#/components/schemas/DocumentsDatabase"
}
],
"nullable": true
},
"systemInfo": {
"type": "string",
"nullable": true
},
"tag": {
"type": "string",
"nullable": true
},
"transactionID": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"varVersion": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TrfFtBytes": {
"type": "object",
"properties": {
"type": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "number",
"format": "double"
},
"length": {
"type": "number",
"format": "double"
},
"data": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TrfFtString": {
"type": "object",
"properties": {
"type": {
"type": "integer",
"format": "int32",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"format": {
"type": "string",
"nullable": true
},
"data": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateEntityInScopeForIdvResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The Id of the Entity in Scope for Idv",
"format": "uuid",
"example": "dc30fd5b-120b-4aaa-bed7-8d8508e24de5"
},
"status": {
"type": "string",
"description": "The status of the Entity in Scope for Idv",
"nullable": true,
"example": "Pending Data"
}
},
"additionalProperties": false
},
"UpdateEntityInScopeForIdvResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateEntityInScopeForIdvResponseDto"
}
],
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"UpdateIdentityVerificationResultRequest": {
"type": "object",
"properties": {
"reviewResult": {
"allOf": [
{
"$ref": "#/components/schemas/ReviewResultBase"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"UpdateIdentityVerificationResultRequestServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateIdentityVerificationResultRequest"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"UpdateIdvReqStatusModelRequestDto": {
"type": "object",
"properties": {
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SingleIdvReqStatusRequestDto"
},
"description": "The statuses of the Idv Requirements",
"nullable": true
}
},
"additionalProperties": false,
"description": "Contains the information needed to update the status of the Idv Requirement"
},
"UpdateIdvReqStatusModelRequestDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateIdvReqStatusModelRequestDto"
}
],
"description": "The service request DTO",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"UpdateScopingRuleSetResponseDto": {
"type": "object",
"properties": {
"version": {
"type": "integer",
"description": "Scoping rule set aggregate version after update",
"format": "int32",
"example": 4
}
},
"additionalProperties": false,
"description": "Response DTO representing updated scoping rule set"
},
"UpdateScopingRuleSetResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateScopingRuleSetResponseDto"
}
],
"description": "Response DTO representing updated scoping rule set",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data"
},
"UpdateScopingRuleSetVersionDto": {
"type": "object",
"properties": {
"effectiveFrom": {
"type": "string",
"description": "The date that the version takes effect when published",
"format": "date-time",
"example": "2021-01-01T14:48:00.000Z"
},
"notes": {
"type": "string",
"description": "Notes related to the Related Party Scoping Rules Version",
"nullable": true
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "Conditions under which the schema can be used",
"nullable": true
},
"version": {
"type": "integer",
"description": "Current version of scoping rule set version aggregate where the changes needs to be applied. This parameter is required\nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking",
"format": "int32",
"default": -1,
"example": 5
}
},
"additionalProperties": false,
"description": "Request DTO representing set of properties which define a new version of scoping rule set"
},
"UpdateScopingRuleSetVersionDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/UpdateScopingRuleSetVersionDto"
}
],
"description": "Request DTO representing set of properties which define a new version of scoping rule set",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service request data"
},
"UserValidationResult": {
"type": "object",
"properties": {
"outcome": {
"type": "string",
"nullable": true
},
"reasoning": {
"type": "string",
"nullable": true
},
"similarity": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"VDItem": {
"type": "object",
"properties": {
"adm": {
"type": "string",
"nullable": true
},
"ctr": {
"type": "string",
"nullable": true
},
"dvc": {
"type": "string",
"nullable": true
},
"lot": {
"type": "string",
"nullable": true
},
"seq": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"VDSData": {
"type": "object",
"properties": {
"certificate": {
"type": "string",
"nullable": true
},
"certificateChain": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RfidCertificateEx"
},
"nullable": true
},
"docFeatures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocFeature"
},
"nullable": true
},
"docIssueDate": {
"type": "string",
"nullable": true
},
"docType": {
"type": "integer",
"format": "int32",
"nullable": true
},
"featureRef": {
"type": "integer",
"format": "int32",
"nullable": true
},
"issuingCountry": {
"type": "string",
"nullable": true
},
"notifications": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"nullable": true
},
"signature": {
"allOf": [
{
"$ref": "#/components/schemas/TrfFtBytes"
}
],
"nullable": true
},
"signatureDate": {
"type": "string",
"nullable": true
},
"signer": {
"type": "string",
"nullable": true
},
"type": {
"type": "integer",
"format": "int32",
"nullable": true
},
"varVersion": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"VDSDataResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"dftVDS": {
"allOf": [
{
"$ref": "#/components/schemas/VDSData"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"VDSNCData": {
"type": "object",
"properties": {
"certificate": {
"allOf": [
{
"$ref": "#/components/schemas/TrfFtBytes"
}
],
"nullable": true
},
"certificateChain": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RfidCertificateEx"
},
"nullable": true
},
"issuingCountry": {
"type": "string",
"nullable": true
},
"message": {
"allOf": [
{
"$ref": "#/components/schemas/Message"
}
],
"nullable": true
},
"notifications": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"nullable": true
},
"signature": {
"allOf": [
{
"$ref": "#/components/schemas/TrfFtBytes"
}
],
"nullable": true
},
"signatureAlg": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"varVersion": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"VDSNCDataResult": {
"allOf": [
{
"$ref": "#/components/schemas/ResultItem"
},
{
"type": "object",
"properties": {
"dftVDSNC": {
"allOf": [
{
"$ref": "#/components/schemas/VDSNCData"
}
],
"nullable": true
}
},
"additionalProperties": false
}
]
},
"VEItem": {
"type": "object",
"properties": {
"des": {
"type": "string",
"nullable": true
},
"dis": {
"type": "string",
"nullable": true
},
"nam": {
"type": "string",
"nullable": true
},
"vd": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VDItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"ValidationErrorModel": {
"type": "object",
"properties": {
"propertyName": {
"type": "string",
"description": "Name of the property",
"nullable": true,
"example": "data"
},
"errorMessage": {
"type": "string",
"description": "User friendly error message",
"nullable": true,
"example": "Data is required"
},
"attemptedValue": {
"description": "Invalid value",
"nullable": true
},
"errorCode": {
"type": "string",
"description": "Internal error code",
"nullable": true,
"example": "NotNullValidator"
}
},
"additionalProperties": false,
"description": "Represents the details of validation error"
},
"ValidationErrorModelListServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationErrorModel"
},
"description": "The service response DTO",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response",
"nullable": true
}
},
"additionalProperties": false,
"description": "Service response data",
"example": {
"data": [
{
"propertyName": "data",
"errorMessage": "Data is required",
"attemptedValue": "",
"errorCode": "NotNullValidator"
}
],
"messages": [
{
"message": "Data is required",
"type": "Error",
"errorCode": "Error Code"
}
]
}
},
"ValueField": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"description": "Value of DataSource used to filter field values",
"nullable": true
},
"field": {
"type": "string",
"description": "Field value used to validate conditional value",
"nullable": true
}
},
"additionalProperties": false
},
"VerificationResult": {
"enum": [
0,
1,
2,
3,
4
],
"type": "integer",
"format": "int32"
},
"VerifiedFieldMap": {
"type": "object",
"properties": {
"wFieldType": {
"allOf": [
{
"$ref": "#/components/schemas/TextFieldType"
}
]
},
"wlcid": {
"allOf": [
{
"$ref": "#/components/schemas/LCID"
}
]
},
"fieldMRZ": {
"type": "string",
"nullable": true
},
"fieldVisual": {
"type": "string",
"nullable": true
},
"fieldBarcode": {
"type": "string",
"nullable": true
},
"fieldRFID": {
"type": "string",
"nullable": true
},
"matrix": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VerificationResult"
},
"nullable": true
}
},
"additionalProperties": false
},
"VersionStatus": {
"enum": [
"Draft",
"Pending",
"Rejected",
"Published",
"Archived",
"Deleted"
],
"type": "string"
},
"VersionedJurisdictionDto": {
"required": [
"jurisdiction"
],
"type": "object",
"properties": {
"jurisdiction": {
"minLength": 1,
"type": "string",
"description": "Jurisdiction of the requirement",
"example": "Global"
},
"versionId": {
"type": "string",
"description": "Version of the requirement jurisdiction",
"format": "uuid",
"nullable": true,
"example": "894e1443-dd7a-4b9d-b253-430c2de80524"
}
},
"additionalProperties": false,
"description": "DTO representing jurisdiction of policy requirement"
},
"Visibility": {
"enum": [
0,
1,
2,
4,
8
],
"type": "integer",
"format": "int32"
},
"VisualExtendedFieldItem": {
"type": "object",
"properties": {
"wFieldType": {
"allOf": [
{
"$ref": "#/components/schemas/TextFieldType"
}
]
},
"wlcid": {
"allOf": [
{
"$ref": "#/components/schemas/LCID"
}
],
"nullable": true
},
"fieldName": {
"type": "string",
"nullable": true
},
"stringsCount": {
"type": "number",
"format": "double"
},
"stringsResult": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StringRecognitionResult"
},
"nullable": true
},
"bufLength": {
"type": "number",
"format": "double"
},
"bufText": {
"type": "string",
"nullable": true
},
"fieldMask": {
"type": "string",
"nullable": true
},
"validity": {
"type": "integer",
"format": "int32",
"nullable": true
},
"inComparison": {
"type": "integer",
"format": "int32",
"nullable": true
},
"reserved2": {
"type": "integer",
"format": "int32",
"nullable": true
},
"reserved3": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Please insert JWT with Bearer into field",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}