{
"openapi": "3.0.1",
"info": {
"title": "Fenergo Nebula Digital IDV Query",
"description": "**Digital IDV Query API**:
Digital IDV Query API provides endpoints in order to query all digital idv resources.
**Digital IDV Query API provides**:
- The ability to query digital idv resources.
",
"version": "1.0"
},
"servers": [
{
"url": "/digitalidvquery"
}
],
"paths": {
"/api/configuration": {
"get": {
"tags": [
"Configuration"
],
"summary": "Get Configuration",
"description": "
Required permissions:
Following permissions are required: DigitalIdvAccess",
"operationId": "GetConfiguration",
"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"
}
],
"responses": {
"200": {
"description": "Instance of Fenergo.Nebula.DigitalIDV.Query.Application.Dto.ConfigurationDto class containing configuration information.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ConfigurationDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ConfigurationDtoServiceResponse"
}
}
}
},
"400": {
"description": "Invalid 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}": {
"get": {
"tags": [
"Configuration"
],
"summary": "Get provider configuration",
"description": "\nThis method returns specific Digital IDV provider
Required permissions:
Following permissions are required: DigitalIdvConfiguration",
"operationId": "GetProviderConfiguration",
"parameters": [
{
"name": "providerId",
"in": "path",
"description": "The ID of provider",
"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": {
"200": {
"description": "Instance of Fenergo.Nebula.DigitalIDV.Query.Application.Dto.ProviderConfigurationDto class containing provider configuration information.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProviderConfigurationDtoServiceResponse"
}
}
}
},
"400": {
"description": "Invalid request.",
"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": "There is no provider with given id",
"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/entity-in-scope/journey/{journeyId}": {
"get": {
"tags": [
"EntityInScopeForIdv"
],
"summary": "Gets all by journey identifier",
"description": "
Required permissions:
Following permissions are required: IdvAccess",
"operationId": "GetAllByJourneyId",
"parameters": [
{
"name": "journeyId",
"in": "path",
"description": "The journey 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": {
"200": {
"description": "A list of the Fenergo.Nebula.DigitalIDV.Query.Application.Dto.EntityInScopeForIdvDto class representing the Entity In Scope if found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EntityInScopeForIdvDtoIEnumerableServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityInScopeForIdvDtoIEnumerableServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EntityInScopeForIdvDtoIEnumerableServiceResponse"
}
}
}
},
"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/journey/{journeyId}/entity/{entityId}": {
"get": {
"tags": [
"EntityInScopeForIdv"
],
"summary": "Gets an Entity In Scope by Journey Id and Entity Id.",
"description": "
Required permissions:
Following permissions are required: IdvAccess",
"operationId": "GetByJourneyIdAndEntityId",
"parameters": [
{
"name": "journeyId",
"in": "path",
"description": "The Journey identifier.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "entityId",
"in": "path",
"description": "The Entity 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": {
"200": {
"description": "A Fenergo.Nebula.DigitalIDV.Query.Application.Dto.EntityInScopeForIdvDto class representing the Entity In Scope if found",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/EntityInScopeForIdvDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityInScopeForIdvDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/EntityInScopeForIdvDtoServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. The Entity is not in scope for the Journey Id and Entity Id provided",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"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/{businessProcessId}": {
"get": {
"tags": [
"IdvBusinessProcess"
],
"summary": "Get an Idv requirements validation business process",
"description": "\nGet the Idv requirements validation business process by id
Required permissions:
Following permissions are required: IdvAccess",
"operationId": "GetIdvRequirementsValidationBusinessProcess",
"parameters": [
{
"name": "businessProcessId",
"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"
}
],
"responses": {
"200": {
"description": "Idv requirements validation business process retrieved successfully",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdvRequirementsValidationBusinessProcessDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdvRequirementsValidationBusinessProcessDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdvRequirementsValidationBusinessProcessDtoServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Business process 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/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/{id}/{configurationVersion}": {
"get": {
"tags": [
"IdvConfiguration"
],
"summary": "Get Idv Configuration",
"description": "
Required permissions:
Following permissions are required: DigitalIdvConfiguration",
"operationId": "GetIdvConfigurationByIdAndVersion",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "configurationVersion",
"in": "path",
"description": "",
"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": {
"200": {
"description": "Instance of Fenergo.Nebula.DigitalIDV.Common.Dto.IdvConfigurationDto class containing Idv configuration information.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
}
}
},
"400": {
"description": "Invalid 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/IdvConfiguration": {
"get": {
"tags": [
"IdvConfiguration"
],
"summary": "Get Idv Configurations",
"description": "
Required permissions:
Following permissions are required: DigitalIdvConfiguration",
"operationId": "GetIdvConfigurations",
"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"
}
],
"responses": {
"200": {
"description": "Instance of Fenergo.Nebula.DigitalIDV.Common.Dto.IdvConfigurationDto class containing a list of all Idv configurations.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationVersionsDtoListServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationVersionsDtoListServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationVersionsDtoListServiceResponse"
}
}
}
},
"400": {
"description": "Invalid 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/IdvConfiguration/extended": {
"get": {
"tags": [
"IdvConfiguration"
],
"summary": "Get Extended Idv Configurations",
"description": "
Required permissions:
Following permissions are required: DigitalIdvConfiguration",
"operationId": "GetExtendedIdvConfigurations",
"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"
}
],
"responses": {
"200": {
"description": "Instance of Fenergo.Nebula.DigitalIDV.Common.Dto.IdvConfigurationExtendedDto class containing a list of all Idv configurations.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationExtendedDtoListServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationExtendedDtoListServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationExtendedDtoListServiceResponse"
}
}
}
},
"400": {
"description": "Invalid 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/IdvConfiguration/draft/{id}": {
"get": {
"tags": [
"IdvConfiguration"
],
"summary": "Get Idv draft Configuration",
"description": "
Required permissions:
Following permissions are required: DigitalIdvConfiguration",
"operationId": "GetDraftById",
"parameters": [
{
"name": "id",
"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"
}
],
"responses": {
"200": {
"description": "Instance of Fenergo.Nebula.DigitalIDV.Common.Dto.IdvConfigurationDto class containing a draft Idv configuration information.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
}
}
},
"400": {
"description": "Invalid 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/IdvConfiguration/{id}": {
"get": {
"tags": [
"IdvConfiguration"
],
"summary": "Get Idv Latest Published Configuration Version",
"description": "
Required permissions:
Following permissions are required: DigitalIdvConfiguration",
"operationId": "GetIdvLatestPublishedConfiguration",
"parameters": [
{
"name": "id",
"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"
}
],
"responses": {
"200": {
"description": "Instance of Fenergo.Nebula.DigitalIDV.Common.Dto.IdvConfigurationDto class containing Idv configuration information.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdvConfigurationDtoServiceResponse"
}
}
}
},
"400": {
"description": "Invalid 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/IdvConfiguration/document-types": {
"get": {
"tags": [
"IdvConfiguration"
],
"summary": "Get the catalogue of document types that can be selected as accepted document types.",
"description": "
Required permissions:
Following permissions are required: DigitalIdvConfiguration",
"operationId": "GetIdvDocumentTypes",
"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"
}
],
"responses": {
"200": {
"description": "Instance of System.Collections.Generic.IReadOnlyCollection`1 containing the available document types.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdvDocumentTypeDtoIReadOnlyCollectionServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdvDocumentTypeDtoIReadOnlyCollectionServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdvDocumentTypeDtoIReadOnlyCollectionServiceResponse"
}
}
}
},
"400": {
"description": "Invalid 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/idv-requirement-status/{id}": {
"get": {
"tags": [
"IdvRequirementStatus"
],
"summary": "Get an Idv Requirement Status Model by Id",
"description": "\nGet the Idv Requirement Statuses for an Id
Required permissions:
Following permissions are required: IdvAccess",
"operationId": "GetIdvRequirementStatusModelById",
"parameters": [
{
"name": "id",
"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"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdvRequirementStatusResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdvRequirementStatusResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdvRequirementStatusResponseDtoServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"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"
},
"202": {
"description": "Idv Requirement Model retrieved successfully"
},
"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/entity/{entityId}/journey/{journeyId}": {
"get": {
"tags": [
"IdvRequirementStatus"
],
"summary": "Get an Idv Requirement Status Model by Entity Id and Journey Id",
"description": "\nGet the Idv Requirement Statuses for an Entity Id and Journey Id
Required permissions:
Following permissions are required: IdvAccess",
"operationId": "GetIdvRequirementStatusModelByEntityIdAndJourneyId",
"parameters": [
{
"name": "entityId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "journeyId",
"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"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdvRequirementStatusResponseDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdvRequirementStatusResponseDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdvRequirementStatusResponseDtoServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"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"
},
"202": {
"description": "Idv Requirement Model retrieved successfully"
},
"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": {
"get": {
"tags": [
"ScopingRuleSet"
],
"summary": "Get all scoping rule sets",
"description": "\nReturns the list of all scoping rule sets.
Required permissions:
Following permissions are required: IdvConfigurationAccess",
"operationId": "GetAllScopingRuleSetsLite",
"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"
}
],
"responses": {
"200": {
"description": "Success. The list of lite scoping rule sets is returned",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ScopingRuleSetLiteDtoIEnumerableServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScopingRuleSetLiteDtoIEnumerableServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ScopingRuleSetLiteDtoIEnumerableServiceResponse"
}
}
}
},
"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}": {
"get": {
"tags": [
"ScopingRuleSet"
],
"summary": "Get the current scoping rule set version by scopingRuleSetId",
"description": "\nReturns the active, currently in effect, published version of scoping rule set for a given rule set id.
Required permissions:
Following permissions are required: IdvConfigurationAccess",
"operationId": "GetCurrentScopingRuleSetVersionByRuleSetId",
"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": {
"200": {
"description": "Success. An instance of scoping rule set is returned",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ScopingRuleSetVersionDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScopingRuleSetVersionDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ScopingRuleSetVersionDtoServiceResponse"
}
}
}
},
"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}": {
"get": {
"tags": [
"ScopingRuleSet"
],
"summary": "Get scoping rule set version by scopingRuleSetId and versionNumber",
"description": "\nReturns scoping rule set version for a given id and version number.
Required permissions:
Following permissions are required: IdvConfigurationAccess",
"operationId": "GetScopingRuleSetVersionByRuleSetIdAndVersionNumber",
"parameters": [
{
"name": "scopingRuleSetId",
"in": "path",
"description": "Scoping rule set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Scoping rule set version number",
"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": {
"200": {
"description": "Success. Scoping rule set is returned",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ScopingRuleSetVersionDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScopingRuleSetVersionDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ScopingRuleSetVersionDtoServiceResponse"
}
}
}
},
"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/version 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/verification/{id}": {
"get": {
"tags": [
"Verification"
],
"summary": "Get verification by id",
"description": "
Required permissions:
Following permissions are required: DigitalIdvAccess",
"operationId": "GetVerification",
"parameters": [
{
"name": "id",
"in": "path",
"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"
}
],
"responses": {
"200": {
"description": "Instance of Fenergo.Nebula.DigitalIDV.Query.Application.Dto.IdentityVerificationDto class containing verification information.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdentityVerificationDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityVerificationDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdentityVerificationDtoServiceResponse"
}
}
}
},
"400": {
"description": "Invalid request",
"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": "Verification with provided id doesn't 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": {
"get": {
"tags": [
"Verification"
],
"summary": "Get verifications by entity type and entity id",
"description": "
Required permissions:
Following permissions are required: DigitalIdvAccess",
"operationId": "GetVerificationsByEntity",
"parameters": [
{
"name": "entityType",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "entityId",
"in": "query",
"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"
}
],
"responses": {
"200": {
"description": "List of Instance of Fenergo.Nebula.DigitalIDV.Query.Application.Dto.IdentityVerificationDto class containing verification information.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdentityVerificationDtoListServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityVerificationDtoListServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdentityVerificationDtoListServiceResponse"
}
}
}
},
"400": {
"description": "Invalid 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/entity/{entityId}/journey/{journeyId}": {
"get": {
"tags": [
"Verification"
],
"summary": "Get identity verification result by entityId and journeyId",
"description": "
Required permissions:
Following permissions are required: DigitalIdvAccess",
"operationId": "GetIdentityVerificationResult",
"parameters": [
{
"name": "entityId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "journeyId",
"in": "path",
"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"
}
],
"responses": {
"200": {
"description": "Instance of Fenergo.Nebula.DigitalIDV.Common.Dto.IdentityVerificationResultsDto class containing verification information.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdentityVerificationResultsDtoServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityVerificationResultsDtoServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdentityVerificationResultsDtoServiceResponse"
}
}
}
},
"400": {
"description": "Invalid request",
"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": "identity verification result with provided entityId and journeyId doesn't 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/entity/{entityId}/journey/{journeyId}/status": {
"get": {
"tags": [
"Verification"
],
"summary": "Get identity verification completeness by entityId and journeyId",
"description": "
Required permissions:
Following permissions are required: DigitalIdvAccess",
"operationId": "GetIdentityVerificationStatus",
"parameters": [
{
"name": "entityId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "journeyId",
"in": "path",
"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"
}
],
"responses": {
"200": {
"description": "Instance of System.Boolean class containing verification information.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/IdentityVerificationStatusResponseServiceResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityVerificationStatusResponseServiceResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/IdentityVerificationStatusResponseServiceResponse"
}
}
}
},
"400": {
"description": "Invalid request",
"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": "identity verification result with provided entityId and journeyId doesn't 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"
}
]
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ApproveAction": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"nullable": true
},
"decision": {
"allOf": [
{
"$ref": "#/components/schemas/Decision"
}
]
},
"created": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"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
},
"BusinessProcessMessageDto": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Business process message",
"nullable": true,
"example": "Error occurred"
},
"messageType": {
"type": "string",
"description": "Type of business process message",
"nullable": true,
"example": "Error"
}
},
"additionalProperties": false,
"description": "Response DTO representing business process message"
},
"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
}
]
},
"ConfigurationDto": {
"type": "object",
"properties": {
"providersConfiguration": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProviderConfigurationDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ConfigurationDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ConfigurationDto"
}
],
"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"
},
"Decision": {
"enum": [
"Approve",
"Reject"
],
"type": "string"
},
"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
},
"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
},
"EntityInScopeForIdvDto": {
"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
},
"EntityInScopeForIdvDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityInScopeForIdvDto"
},
"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"
},
"EntityInScopeForIdvDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/EntityInScopeForIdvDto"
}
],
"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"
},
"HttpValidationProblemDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"type": "object",
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"nullable": true
}
},
"additionalProperties": { }
}
]
},
"IdentityVerificationDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"entityType": {
"type": "string",
"nullable": true
},
"entityId": {
"type": "string",
"nullable": true
},
"transactionId": {
"type": "string",
"nullable": true
},
"providerId": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"transactionUrl": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"documentStatus": {
"type": "string",
"nullable": true
},
"resultHandlingStatus": {
"type": "string",
"nullable": true
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VerificationDocumentDto"
},
"nullable": true
},
"isActive": {
"type": "boolean"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contextValues": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"IdentityVerificationDtoListServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdentityVerificationDto"
},
"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"
},
"IdentityVerificationDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/IdentityVerificationDto"
}
],
"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"
},
"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"
},
"IdentityVerificationStatusResponse": {
"type": "object",
"properties": {
"isCompleted": {
"type": "boolean"
}
},
"additionalProperties": false
},
"IdentityVerificationStatusResponseServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/IdentityVerificationStatusResponse"
}
],
"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"
},
"IdvCommonPageConfigurationDto": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
}
},
"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
},
"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"
},
"IdvConfigurationExtended": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"version": {
"type": "integer",
"format": "int32"
},
"isDraft": {
"type": "boolean"
},
"isArchived": {
"type": "boolean"
},
"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"
},
"status": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"effectiveFrom": {
"type": "string",
"format": "date-time"
},
"effectiveUntil": {
"type": "string",
"format": "date-time",
"nullable": true
},
"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
},
"IdvConfigurationExtendedDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdvConfigurationExtended"
},
"nullable": true
}
},
"additionalProperties": false
},
"IdvConfigurationExtendedDtoListServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdvConfigurationExtendedDto"
},
"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"
},
"IdvConfigurationSummaryDto": {
"type": "object",
"properties": {
"idvConfigurationId": {
"type": "string",
"nullable": true
},
"version": {
"type": "integer",
"format": "int32"
},
"versionNotes": {
"type": "string",
"nullable": true
},
"effectiveFrom": {
"type": "string",
"format": "date-time"
},
"effectiveUntil": {
"type": "string",
"format": "date-time",
"nullable": true
},
"created": {
"type": "string",
"format": "date-time"
},
"maxAttempts": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"IdvConfigurationVersionsDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdvConfigurationSummaryDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"IdvConfigurationVersionsDtoListServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdvConfigurationVersionsDto"
},
"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"
},
"IdvDocumentTypeDto": {
"type": "object",
"properties": {
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"IdvDocumentTypeDtoIReadOnlyCollectionServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdvDocumentTypeDto"
},
"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"
},
"IdvRequirementStatusDto": {
"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": "Complete"
},
"ownershipAndControlDataKey": {
"type": "string",
"description": "The DataKey of the Requirement",
"nullable": true,
"example": "e28a3705-927b-47cd-98bc-b2ad63a6fa69"
},
"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 the data relating to an Idv Requirement Status"
},
"IdvRequirementStatusResponseDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of the model",
"format": "uuid",
"example": "410871d0-d2c6-4d2f-96ea-2fd652c1a92d"
},
"entityId": {
"type": "string",
"description": "The Id of the current 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/IdvRequirementStatusDto"
},
"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"
},
"IdvRequirementStatusResponseDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/IdvRequirementStatusResponseDto"
}
],
"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"
},
"IdvRequirementValidationErrorDto": {
"type": "object",
"properties": {
"errorMessage": {
"type": "string",
"description": "Error message",
"nullable": true,
"example": "Field is required"
}
},
"additionalProperties": false,
"description": "Response DTO representing validation error data of Idv requirements validation business process item"
},
"IdvRequirementsValidationBusinessProcessDto": {
"type": "object",
"properties": {
"businessProcessId": {
"type": "string",
"description": "The UiD of the business process",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"status": {
"type": "string",
"description": "Status of business process",
"nullable": true,
"example": "In Progress"
},
"payload": {
"allOf": [
{
"$ref": "#/components/schemas/IdvRequirementsValidationBusinessProcessPayloadDto"
}
],
"description": "Business process payload",
"nullable": true
},
"created": {
"type": "string",
"description": "Business process created date",
"format": "date-time",
"example": "2021-01-05T14:48:00.000Z"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessProcessMessageDto"
},
"description": "Business process messages",
"nullable": true
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdvRequirementsValidationBusinessProcessItemDto"
},
"description": "Business Process items",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response DTO representing Idv requirements validation business process"
},
"IdvRequirementsValidationBusinessProcessDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/IdvRequirementsValidationBusinessProcessDto"
}
],
"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"
},
"IdvRequirementsValidationBusinessProcessItemDto": {
"type": "object",
"properties": {
"requirementId": {
"type": "string",
"description": "The UiD of the Idv requirement",
"format": "uuid",
"example": "a5cfd4e8-732f-4601-ac88-652b64c8439c"
},
"idvLabel": {
"type": "string",
"description": "Label of the Idv requirement",
"nullable": true,
"example": "Idv requirement label"
},
"idvTooltip": {
"type": "string",
"description": "Tooltip of the Idv requirement",
"nullable": true,
"example": "Idv requirement tooltip"
},
"category": {
"type": "string",
"description": "Category of the Idv requirement",
"nullable": true,
"example": "Basic Details"
},
"isValid": {
"type": "boolean",
"description": "Flag to determine if Idv requirements validation business process item is valid or not",
"example": true
},
"validationErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IdvRequirementValidationErrorDto"
},
"description": "Validation errors of the Idv requirements validation business process item",
"nullable": true
},
"relationshipTypes": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Relationship types of the Idv requirements validation business process item",
"nullable": true
},
"status": {
"type": "string",
"description": "Status of the Idv requirements validation business process item",
"nullable": true,
"example": "In Progress"
}
},
"additionalProperties": false,
"description": "Response DTO representing Idv requirements validation business process item"
},
"IdvRequirementsValidationBusinessProcessPayloadDto": {
"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 Task",
"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 used for Idv requirements validation business process",
"nullable": true
},
"jurisdictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VersionedJurisdictionDto"
},
"description": "Jurisdictions used for Idv requirements validation business process",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response DTO representing Idv requirements validation business process payload"
},
"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
},
"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
},
"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"
},
"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": { }
},
"ProviderConfigurationDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"localConfiguration": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SchemaEntry"
},
"nullable": true
},
"globalConfiguration": {
"type": "object",
"additionalProperties": {
"nullable": true
},
"nullable": true
}
},
"additionalProperties": false
},
"ProviderConfigurationDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ProviderConfigurationDto"
}
],
"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"
},
"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
},
"SchemaEntry": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"friendlyName": {
"type": "string",
"nullable": true
},
"value": {
"nullable": true
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/ValueType"
}
]
},
"masked": {
"type": "boolean"
},
"nullable": {
"type": "boolean"
},
"mandatory": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ScopingRuleSetLiteDto": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UiD of the scoping rule set",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"name": {
"minLength": 1,
"type": "string",
"description": "Scoping rule set name",
"example": "Global"
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScopingRuleSetLiteVersionDto"
},
"description": "Versions associated to the scoping rule set",
"nullable": true
},
"version": {
"type": "integer",
"description": "Version number for given Aggregate (concurrency check)",
"format": "int32",
"example": 1
}
},
"additionalProperties": false,
"description": "Represents a lite version of a Scoping Rule Set"
},
"ScopingRuleSetLiteDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScopingRuleSetLiteDto"
},
"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"
},
"ScopingRuleSetLiteVersionDto": {
"required": [
"name"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UiD of the scoping rule set version",
"format": "uuid",
"example": "228313c6-91e6-4b05-a537-5a1ab906418f"
},
"scopingRuleSetId": {
"type": "string",
"description": "The UiD of the scoping rule set that the version belongs to",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"name": {
"minLength": 1,
"type": "string",
"description": "Display name of scoping rule set",
"example": "Global Scoping Rules"
},
"versionNumber": {
"type": "integer",
"description": "The versions number",
"format": "int32",
"example": 1
},
"effectiveFrom": {
"type": "string",
"description": "The date that the version takes effect when published",
"format": "date-time",
"example": "2021-01-01T14:48:00.000Z"
},
"effectiveUntil": {
"type": "string",
"description": "The calculated date that the version ceases being active",
"format": "date-time",
"nullable": true,
"example": "2021-01-01T14:48:00.000Z"
},
"publicationDate": {
"type": "string",
"description": "The date that the version got published",
"format": "date-time",
"nullable": true,
"example": "2021-01-01T14:48:00.000Z"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
],
"description": "The status of the version",
"example": "Published"
},
"created": {
"type": "string",
"description": "The creation date of the version",
"format": "date-time",
"example": "2021-01-01T14:48:00.000Z"
},
"isActive": {
"type": "boolean",
"description": "The calculated flag to annotate whether this is the model's latest version\nat the time of the query (not necessarily published)",
"example": true
},
"version": {
"type": "integer",
"description": "Version number for given Aggregate (concurrency check)",
"format": "int32",
"nullable": true,
"example": 1
},
"notes": {
"type": "string",
"description": "Notes related to the Related Party Scoping Rules Version",
"nullable": true,
"example": "Version Notes"
}
},
"additionalProperties": false,
"description": "Represents a lite version of a Scoping Rule Set version"
},
"ScopingRuleSetVersionDto": {
"allOf": [
{
"$ref": "#/components/schemas/ScopingRuleSetLiteVersionDto"
},
{
"required": [
"signees"
],
"type": "object",
"properties": {
"signees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SigneeDto"
},
"description": "The defined list of signees for the version"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "Conditions under which the schema can be used",
"nullable": true
}
},
"additionalProperties": false
}
],
"description": "Response DTO representing scoping rule set version data"
},
"ScopingRuleSetVersionDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ScopingRuleSetVersionDto"
}
],
"description": "Response DTO representing scoping rule set version 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"
},
"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"
},
"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"
},
"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
},
"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"
},
"T": {
"type": "object",
"additionalProperties": false
},
"UserValidationResult": {
"type": "object",
"properties": {
"outcome": {
"type": "string",
"nullable": true
},
"reasoning": {
"type": "string",
"nullable": true
},
"similarity": {
"type": "string",
"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
},
"ValueType": {
"enum": [
"String",
"Number"
],
"type": "string"
},
"VerificationDocumentDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"VersionStatus": {
"enum": [
"Draft",
"Pending",
"Rejected",
"Published",
"Archived",
"Deleted"
],
"type": "string"
},
"VersionedJurisdictionDto": {
"type": "object",
"properties": {
"jurisdiction": {
"type": "string",
"description": "Jurisdiction of the requirement",
"nullable": true,
"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"
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Please insert JWT with Bearer into field",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}