openapi: 3.2.0 info: title: Fenergo Idv Configuration API version: '1.0' description: 'Operations tagged IdvConfiguration across 4 of this provider''s published API definitions: fenergo-digitalidvcommand-v1-0-openapi.json, fenergo-digitalidvcommand-v2-0-openapi.json, fenergo-digitalidvquery-v1-0-openapi.json, fenergo-digitalidvquery-v2-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /digitalidvcommand - url: /digitalidvquery security: - Bearer: [] tags: - name: IdvConfiguration paths: /api/IdvConfiguration/create/configuration: post: tags: - IdvConfiguration summary: Creates a new Idv Configuration with a first draft version description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: CreateIdvConfiguration parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/IdvNewConfigurationDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/IdvNewConfigurationDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/IdvNewConfigurationDtoServiceRequest' description: Service request data responses: '200': description: Idv draft configuration created successfully content: text/plain: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /digitalidvcommand /api/IdvConfiguration/create/draft: post: tags: - IdvConfiguration summary: Create Draft Idv Configuration description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: CreateDraftIdvConfiguration parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateDraftIdvConfigurationDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/CreateDraftIdvConfigurationDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/CreateDraftIdvConfigurationDtoServiceRequest' description: Service request data responses: '200': description: Idv draft configuration created successfully content: text/plain: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /digitalidvcommand /api/IdvConfiguration/update/draft: put: tags: - IdvConfiguration summary: Update Idv Configuration description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: UpdateDraftIdvConfiguration parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/IdvConfigurationDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/IdvConfigurationDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/IdvConfigurationDtoServiceRequest' description: Service request data responses: '200': description: Idv draft configuration updated successfully content: text/plain: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /digitalidvcommand /api/IdvConfiguration/delete/draft: post: tags: - IdvConfiguration summary: Delete Idv Configuration description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: DeleteDraftIdvConfiguration parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/GuidServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/GuidServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/GuidServiceRequest' description: Service request data responses: '200': description: Idv draft configuration deleted successfully content: text/plain: schema: $ref: '#/components/schemas/BooleanServiceResponse' application/json: schema: $ref: '#/components/schemas/BooleanServiceResponse' text/json: schema: $ref: '#/components/schemas/BooleanServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /digitalidvcommand /api/IdvConfiguration/publish: post: tags: - IdvConfiguration summary: Publish Idv Configuration description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: PublishDraftIdvConfiguration parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/GuidServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/GuidServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/GuidServiceRequest' description: Service request data responses: '200': description: Idv draft configuration published successfully content: text/plain: schema: $ref: '#/components/schemas/BooleanServiceResponse' application/json: schema: $ref: '#/components/schemas/BooleanServiceResponse' text/json: schema: $ref: '#/components/schemas/BooleanServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /digitalidvcommand /api/IdvConfiguration/archive: post: tags: - IdvConfiguration summary: Archive Idv Configuration description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: ArchivePublishedIdvConfiguration parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/IdvConfigurationDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/IdvConfigurationDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/IdvConfigurationDtoServiceRequest' description: Service request data responses: '200': description: Idv published configuration archived successfully content: text/plain: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /digitalidvcommand /api/v2/IdvConfiguration/create/configuration: post: tags: - IdvConfiguration summary: Creates a new Idv Configuration with a first draft version description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: postApiV2IdvConfigurationCreateConfiguration parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/IdvNewConfigurationDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/IdvNewConfigurationDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/IdvNewConfigurationDtoServiceRequest' description: Service request data responses: '200': description: Idv draft configuration created successfully content: text/plain: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateIdvConfiguration servers: - url: /digitalidvcommand /api/v2/IdvConfiguration/create/draft: post: tags: - IdvConfiguration summary: Create Draft Idv Configuration description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: postApiV2IdvConfigurationCreateDraft parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateDraftIdvConfigurationDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/CreateDraftIdvConfigurationDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/CreateDraftIdvConfigurationDtoServiceRequest' description: Service request data responses: '200': description: Idv draft configuration created successfully content: text/plain: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateDraftIdvConfiguration servers: - url: /digitalidvcommand /api/v2/IdvConfiguration/update/draft: put: tags: - IdvConfiguration summary: Update Idv Configuration description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: putApiV2IdvConfigurationUpdateDraft parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/IdvConfigurationDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/IdvConfigurationDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/IdvConfigurationDtoServiceRequest' description: Service request data responses: '200': description: Idv draft configuration updated successfully content: text/plain: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: UpdateDraftIdvConfiguration servers: - url: /digitalidvcommand /api/v2/IdvConfiguration/delete/draft: post: tags: - IdvConfiguration summary: Delete Idv Configuration description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: postApiV2IdvConfigurationDeleteDraft parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/GuidServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/GuidServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/GuidServiceRequest' description: Service request data responses: '200': description: Idv draft configuration deleted successfully content: text/plain: schema: $ref: '#/components/schemas/BooleanServiceResponse' application/json: schema: $ref: '#/components/schemas/BooleanServiceResponse' text/json: schema: $ref: '#/components/schemas/BooleanServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: DeleteDraftIdvConfiguration servers: - url: /digitalidvcommand /api/v2/IdvConfiguration/publish: post: tags: - IdvConfiguration summary: Publish Idv Configuration description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: postApiV2IdvConfigurationPublish parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/GuidServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/GuidServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/GuidServiceRequest' description: Service request data responses: '200': description: Idv draft configuration published successfully content: text/plain: schema: $ref: '#/components/schemas/BooleanServiceResponse' application/json: schema: $ref: '#/components/schemas/BooleanServiceResponse' text/json: schema: $ref: '#/components/schemas/BooleanServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: PublishDraftIdvConfiguration servers: - url: /digitalidvcommand /api/v2/IdvConfiguration/archive: post: tags: - IdvConfiguration summary: Archive Idv Configuration description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: postApiV2IdvConfigurationArchive parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/IdvConfigurationDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/IdvConfigurationDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/IdvConfigurationDtoServiceRequest' description: Service request data responses: '200': description: Idv published configuration archived successfully content: text/plain: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/IdvConfigurationDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: ArchivePublishedIdvConfiguration servers: - url: /digitalidvcommand /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 servers: - url: /digitalidvquery /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 servers: - url: /digitalidvquery /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 servers: - url: /digitalidvquery /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 servers: - url: /digitalidvquery /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 servers: - url: /digitalidvquery /api/IdvConfiguration/document-types: get: tags: - IdvConfiguration summary: Get the catalogue of document types that can be selected as accepted document… 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 servers: - url: /digitalidvquery /api/v2/IdvConfiguration/{id}/{configurationVersion}: get: tags: - IdvConfiguration summary: Get Idv Configuration description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: getApiV2IdvConfigurationByIdByConfigurationVersion 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 x-operation-id-source: normalized x-operation-id-original: GetIdvConfigurationByIdAndVersion servers: - url: /digitalidvquery /api/v2/IdvConfiguration: get: tags: - IdvConfiguration summary: Get Idv Configurations description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: getApiV2IdvConfiguration 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 x-operation-id-source: normalized x-operation-id-original: GetIdvConfigurations servers: - url: /digitalidvquery /api/v2/IdvConfiguration/extended: get: tags: - IdvConfiguration summary: Get Extended Idv Configurations description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: getApiV2IdvConfigurationExtended 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 x-operation-id-source: normalized x-operation-id-original: GetExtendedIdvConfigurations servers: - url: /digitalidvquery /api/v2/IdvConfiguration/draft/{id}: get: tags: - IdvConfiguration summary: Get Idv draft Configuration description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: getApiV2IdvConfigurationDraftById 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 x-operation-id-source: normalized x-operation-id-original: GetDraftById servers: - url: /digitalidvquery /api/v2/IdvConfiguration/{id}: get: tags: - IdvConfiguration summary: Get Idv Latest Published Configuration Version description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: getApiV2IdvConfigurationById 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 x-operation-id-source: normalized x-operation-id-original: GetIdvLatestPublishedConfiguration servers: - url: /digitalidvquery /api/v2/IdvConfiguration/document-types: get: tags: - IdvConfiguration summary: Get the catalogue of document types that can be selected as accepted document… description: 'Required permissions: Following permissions are required: DigitalIdvConfiguration' operationId: getApiV2IdvConfigurationDocumentTypes 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 x-operation-id-source: normalized x-operation-id-original: GetIdvDocumentTypes servers: - url: /digitalidvquery components: schemas: ServiceResponse: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data IdvNewConfigurationDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/IdvNewConfigurationDto' description: The service request DTO additionalProperties: false description: Service request data GuidServiceRequest: type: object properties: data: type: string description: The service request DTO format: uuid additionalProperties: false description: Service request data CreateDraftIdvConfigurationDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateDraftIdvConfigurationDto' description: The service request DTO additionalProperties: false description: Service request data IdvNewConfigurationDto: type: object properties: name: type: - string - 'null' description: type: - string - 'null' documentCaptureTypes: type: - array - 'null' items: type: string acceptedDocumentTypes: type: - array - 'null' items: type: string livenessType: type: - string - 'null' versionNotes: type: - string - 'null' livenessTestEnabled: type: boolean maxAttempts: type: integer format: int32 landingPageConfig: allOf: - $ref: '#/components/schemas/IdvCommonPageConfigurationDto' selfieStartScreenConfig: allOf: - $ref: '#/components/schemas/IdvCommonPageConfigurationDto' documentCaptureConfig: allOf: - $ref: '#/components/schemas/IdvCommonPageConfigurationDto' additionalProperties: false IdvCommonPageConfigurationDto: required: - message - title type: object properties: title: minLength: 1 type: string message: minLength: 1 type: string additionalProperties: false IdvConfigurationDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/IdvConfigurationDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data CreateDraftIdvConfigurationDto: type: object properties: id: type: string format: uuid version: type: integer format: int32 additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response BooleanServiceResponse: type: object properties: data: type: boolean description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data IdvConfigurationDtoServiceRequest: required: - data type: object properties: data: allOf: - $ref: '#/components/schemas/IdvConfigurationDto' description: The service request DTO additionalProperties: false description: Service request data StringServiceResponse: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ObjectServiceResponse: type: object properties: data: description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data IdvConfigurationDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' documentCaptureTypes: type: - array - 'null' items: type: string acceptedDocumentTypes: type: - array - 'null' items: type: string livenessType: type: - string - 'null' versionNotes: type: - string - 'null' 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' selfieStartScreenConfig: allOf: - $ref: '#/components/schemas/IdvCommonPageConfigurationDto' documentCaptureConfig: allOf: - $ref: '#/components/schemas/IdvCommonPageConfigurationDto' additionalProperties: false IdvDocumentTypeDto: type: object properties: code: type: - string - 'null' name: type: - string - 'null' additionalProperties: false IdvConfigurationExtendedDto: type: object properties: id: type: string format: uuid versions: type: - array - 'null' items: $ref: '#/components/schemas/IdvConfigurationExtended' additionalProperties: false IdvConfigurationSummaryDto: type: object properties: idvConfigurationId: type: - string - 'null' version: type: integer format: int32 versionNotes: type: - string - 'null' effectiveFrom: type: string format: date-time effectiveUntil: type: - string - 'null' format: date-time created: type: string format: date-time maxAttempts: type: integer format: int32 status: type: - string - 'null' name: type: - string - 'null' isActive: type: boolean additionalProperties: false IdvCommonPageConfigurationDto_2: type: object properties: title: type: - string - 'null' message: type: - string - 'null' additionalProperties: false IdvConfigurationVersionsDtoListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/IdvConfigurationVersionsDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data IdvDocumentTypeDtoIReadOnlyCollectionServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/IdvDocumentTypeDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data IdvConfigurationExtendedDtoListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/IdvConfigurationExtendedDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data IdvConfigurationExtended: type: object properties: name: type: - string - 'null' id: type: string format: uuid version: type: integer format: int32 isDraft: type: boolean isArchived: type: boolean description: type: - string - 'null' documentCaptureTypes: type: - array - 'null' items: type: string acceptedDocumentTypes: type: - array - 'null' items: type: string livenessType: type: - string - 'null' versionNotes: type: - string - 'null' livenessTestEnabled: type: boolean maxAttempts: type: integer format: int32 status: type: - string - 'null' isActive: type: boolean effectiveFrom: type: string format: date-time effectiveUntil: type: - string - 'null' format: date-time landingPageConfig: allOf: - $ref: '#/components/schemas/IdvCommonPageConfigurationDto_2' selfieStartScreenConfig: allOf: - $ref: '#/components/schemas/IdvCommonPageConfigurationDto_2' documentCaptureConfig: allOf: - $ref: '#/components/schemas/IdvCommonPageConfigurationDto_2' additionalProperties: false IdvConfigurationVersionsDto: type: object properties: id: type: string format: uuid versions: type: - array - 'null' items: $ref: '#/components/schemas/IdvConfigurationSummaryDto' additionalProperties: false IdvCommonPageConfigurationDto_3: type: object properties: title: type: - string - 'null' message: type: - string - 'null' additionalProperties: false IdvConfigurationExtended_2: type: object properties: name: type: - string - 'null' id: type: string format: uuid version: type: integer format: int32 isDraft: type: boolean isArchived: type: boolean description: type: - string - 'null' documentCaptureTypes: type: - array - 'null' items: type: string acceptedDocumentTypes: type: - array - 'null' items: type: string livenessType: type: - string - 'null' versionNotes: type: - string - 'null' livenessTestEnabled: type: boolean maxAttempts: type: integer format: int32 status: type: - string - 'null' isActive: type: boolean effectiveFrom: type: string format: date-time effectiveUntil: type: - string - 'null' format: date-time landingPageConfig: allOf: - $ref: '#/components/schemas/IdvCommonPageConfigurationDto_3' selfieStartScreenConfig: allOf: - $ref: '#/components/schemas/IdvCommonPageConfigurationDto_3' documentCaptureConfig: allOf: - $ref: '#/components/schemas/IdvCommonPageConfigurationDto_3' additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-digitalidvcommand-v1-0-openapi.json - fenergo-digitalidvcommand-v2-0-openapi.json - fenergo-digitalidvquery-v1-0-openapi.json - fenergo-digitalidvquery-v2-0-openapi.json