openapi: 3.2.0 info: title: Fenergo Idv Requirement Status API version: '1.0' description: 'Operations tagged IdvRequirementStatus 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: IdvRequirementStatus paths: /api/idv-requirement-status: post: tags: - IdvRequirementStatus summary: Create new Idv Requirement Status Model description: 'This method will create a new Idv Requirement Status Model The new model will initialize with the DTO data. Required permissions: Following permissions are required: IdvEdit' operationId: CreateIdvRequirementStatusModel parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.DigitalIDV.Command.Application.Dto.IdvRequirementStatus.CreateIdvRequirementStatusModelRequestDto to create content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateIdvRequirementStatusModelRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/CreateIdvRequirementStatusModelRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/CreateIdvRequirementStatusModelRequestDtoServiceRequest' description: Service request data responses: '202': description: Idv Requirement Model created successfully content: text/plain: schema: $ref: '#/components/schemas/IdvReqStatusModelResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/IdvReqStatusModelResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/IdvReqStatusModelResponseDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /digitalidvcommand /api/idv-requirement-status/create-single-status: post: tags: - IdvRequirementStatus summary: Create single Idv Requirement Status description: 'This method will create a new Idv Requirement Status The new model will initialize with the DTO data. Parent model will be created if it has not been created already. Required permissions: Following permissions are required: IdvEdit' operationId: CreateSingleIdvRequirementStatusModel parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.DigitalIDV.Command.Application.Dto.IdvRequirementStatus.CreateSingleIdvRequirementStatusRequestDto to create content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateSingleIdvRequirementStatusRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/CreateSingleIdvRequirementStatusRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/CreateSingleIdvRequirementStatusRequestDtoServiceRequest' description: Service request data responses: '202': description: Idv Requirement Status created successfully content: text/plain: schema: $ref: '#/components/schemas/IdvReqStatusModelResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/IdvReqStatusModelResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/IdvReqStatusModelResponseDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /digitalidvcommand /api/idv-requirement-status/{id}: put: tags: - IdvRequirementStatus summary: Update existing Idv Requirement Status Model description: 'This method will update an existing Idv Requirement Status Model The model will be updated with the DTO data. Required permissions: Following permissions are required: IdvEdit' operationId: UpdateIdvRequirementStatusModel parameters: - name: id in: path description: The identifier. required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.DigitalIDV.Command.Application.Dto.IdvRequirementStatus.UpdateIdvReqStatusModelRequestDto to update content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateIdvReqStatusModelRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/UpdateIdvReqStatusModelRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/UpdateIdvReqStatusModelRequestDtoServiceRequest' description: Service request data responses: '202': description: Idv Requirement Model updated successfully '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - IdvRequirementStatus summary: Get an Idv Requirement Status Model by Id description: 'Get 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 servers: - url: /digitalidvcommand /api/idv-requirement-status/update-single-status/{id}: put: tags: - IdvRequirementStatus summary: Update single Idv Requirement Status description: 'This method will update a single Idv Requirement Status. Required permissions: Following permissions are required: IdvEdit' operationId: UpdateSingleIdvRequirementStatus parameters: - name: id in: path description: The identifier. required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.DigitalIDV.Command.Application.Dto.IdvRequirementStatus.SingleIdvReqStatusRequestDto to update content: application/json: schema: allOf: - $ref: '#/components/schemas/SingleIdvReqStatusRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/SingleIdvReqStatusRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/SingleIdvReqStatusRequestDtoServiceRequest' description: Service request data responses: '202': description: Idv Requirement Model updated successfully '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /digitalidvcommand /api/idv-requirement-status/measure-completeness: post: tags: - IdvRequirementStatus summary: Measures the completeness of Ownership and Control Idv requirements description: 'Required permissions: At least one of the following permissions is required: IdvEdit, IdvAccess' operationId: MeasureCompleteness parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.DigitalIDV.MeasureCompleteness.Dto.MeasureCompletenessRequestDto data used in the calculation content: application/json: schema: allOf: - $ref: '#/components/schemas/MeasureCompletenessRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/MeasureCompletenessRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/MeasureCompletenessRequestDtoServiceRequest' description: Service request data responses: '202': description: Idv Requirements successfully evaluated content: text/plain: schema: $ref: '#/components/schemas/MeasureCompletenessResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/MeasureCompletenessResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/MeasureCompletenessResponseDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /digitalidvcommand /api/v2/idv-requirement-status: post: tags: - IdvRequirementStatus summary: Create new Idv Requirement Status Model description: 'This method will create a new Idv Requirement Status Model The new model will initialize with the DTO data. Required permissions: Following permissions are required: IdvEdit' operationId: postApiV2IdvRequirementStatus parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.DigitalIDV.Command.Application.Dto.IdvRequirementStatus.CreateIdvRequirementStatusModelRequestDto to create content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateIdvRequirementStatusModelRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/CreateIdvRequirementStatusModelRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/CreateIdvRequirementStatusModelRequestDtoServiceRequest' description: Service request data responses: '202': description: Idv Requirement Model created successfully content: text/plain: schema: $ref: '#/components/schemas/IdvReqStatusModelResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/IdvReqStatusModelResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/IdvReqStatusModelResponseDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateIdvRequirementStatusModel servers: - url: /digitalidvcommand /api/v2/idv-requirement-status/create-single-status: post: tags: - IdvRequirementStatus summary: Create single Idv Requirement Status description: 'This method will create a new Idv Requirement Status The new model will initialize with the DTO data. Parent model will be created if it has not been created already. Required permissions: Following permissions are required: IdvEdit' operationId: postApiV2IdvRequirementStatusCreateSingleStatus parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.DigitalIDV.Command.Application.Dto.IdvRequirementStatus.CreateSingleIdvRequirementStatusRequestDto to create content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateSingleIdvRequirementStatusRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/CreateSingleIdvRequirementStatusRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/CreateSingleIdvRequirementStatusRequestDtoServiceRequest' description: Service request data responses: '202': description: Idv Requirement Status created successfully content: text/plain: schema: $ref: '#/components/schemas/IdvReqStatusModelResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/IdvReqStatusModelResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/IdvReqStatusModelResponseDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateSingleIdvRequirementStatusModel servers: - url: /digitalidvcommand /api/v2/idv-requirement-status/{id}: put: tags: - IdvRequirementStatus summary: Update existing Idv Requirement Status Model description: 'This method will update an existing Idv Requirement Status Model The model will be updated with the DTO data. Required permissions: Following permissions are required: IdvEdit' operationId: putApiV2IdvRequirementStatusById parameters: - name: id in: path description: The identifier. required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.DigitalIDV.Command.Application.Dto.IdvRequirementStatus.UpdateIdvReqStatusModelRequestDto to update content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateIdvReqStatusModelRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/UpdateIdvReqStatusModelRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/UpdateIdvReqStatusModelRequestDtoServiceRequest' description: Service request data responses: '202': description: Idv Requirement Model updated successfully '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: UpdateIdvRequirementStatusModel get: tags: - IdvRequirementStatus summary: Get an Idv Requirement Status Model by Id description: 'Get the Idv Requirement Statuses for an Id Required permissions: Following permissions are required: IdvAccess' operationId: getApiV2IdvRequirementStatusById 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 x-operation-id-source: normalized x-operation-id-original: GetIdvRequirementStatusModelById servers: - url: /digitalidvcommand /api/v2/idv-requirement-status/update-single-status/{id}: put: tags: - IdvRequirementStatus summary: Update single Idv Requirement Status description: 'This method will update a single Idv Requirement Status. Required permissions: Following permissions are required: IdvEdit' operationId: putApiV2IdvRequirementStatusUpdateSingleStatusById parameters: - name: id in: path description: The identifier. required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.DigitalIDV.Command.Application.Dto.IdvRequirementStatus.SingleIdvReqStatusRequestDto to update content: application/json: schema: allOf: - $ref: '#/components/schemas/SingleIdvReqStatusRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/SingleIdvReqStatusRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/SingleIdvReqStatusRequestDtoServiceRequest' description: Service request data responses: '202': description: Idv Requirement Model updated successfully '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: UpdateSingleIdvRequirementStatus servers: - url: /digitalidvcommand /api/v2/idv-requirement-status/measure-completeness: post: tags: - IdvRequirementStatus summary: Measures the completeness of Ownership and Control Idv requirements description: 'Required permissions: At least one of the following permissions is required: IdvEdit, IdvAccess' operationId: postApiV2IdvRequirementStatusMeasureCompleteness parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.DigitalIDV.MeasureCompleteness.Dto.MeasureCompletenessRequestDto data used in the calculation content: application/json: schema: allOf: - $ref: '#/components/schemas/MeasureCompletenessRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/MeasureCompletenessRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/MeasureCompletenessRequestDtoServiceRequest' description: Service request data responses: '202': description: Idv Requirements successfully evaluated content: text/plain: schema: $ref: '#/components/schemas/MeasureCompletenessResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/MeasureCompletenessResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/MeasureCompletenessResponseDtoServiceResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: MeasureCompleteness servers: - url: /digitalidvcommand /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: 'Get 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 servers: - url: /digitalidvquery /api/v2/idv-requirement-status/entity/{entityId}/journey/{journeyId}: get: tags: - IdvRequirementStatus summary: Get an Idv Requirement Status Model by Entity Id and Journey Id description: 'Get the Idv Requirement Statuses for an Entity Id and Journey Id Required permissions: Following permissions are required: IdvAccess' operationId: getApiV2IdvRequirementStatusEntityByEntityIdJourneyByJourneyId 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 x-operation-id-source: normalized x-operation-id-original: GetIdvRequirementStatusModelByEntityIdAndJourneyId servers: - url: /digitalidvquery components: schemas: SingleIdvReqStatusRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/SingleIdvReqStatusRequestDto' description: The service request DTO additionalProperties: false description: Service request data MeasureCompletenessResponseDto: type: object properties: id: type: - string - 'null' description: The Id of the Model example: fa8cb45d-ac78-4c4e-b701-ffcc2c9e79cf journeyId: type: - string - 'null' description: The Id of the Journey example: 19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769 entityId: type: - string - 'null' description: The Id of the Entity example: 315df981-38a0-4145-836b-8d22745887b6 statuses: type: - array - 'null' items: $ref: '#/components/schemas/MeasureCompletenessStatusResponse' description: The statuses of the Idv requirement additionalProperties: false description: Contains all the information needed to store the status of the Completeness response SingleIdvReqStatusRequestDto: required: - requirementId type: object properties: requirementId: minLength: 1 type: string description: The Id of the Requirement format: uuid example: 580565ee-0700-4aec-854d-8cc9dbb58bc1 status: type: - string - 'null' description: The status of the Idv Requirement example: Completed ownershipAndControlDataKey: type: - string - 'null' description: The DataKey of the Requirement example: addAllUBOs requirementName: type: - string - 'null' description: The Name of the Requirement example: Add All UBOs idvMinimumPartyCount: type: - integer - 'null' description: The Minimum Idv Party Count needed to validate the Requirement format: int32 example: 2 idvAllParties: type: - boolean - 'null' description: The attribute which specifies if all Related Parties that meet the criteria need to be Idv compliant example: false additionalProperties: false description: Contains the data for updating an Idv Requirement Status IdvReqStatusModelResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/IdvReqStatusModelResponseDto' 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 UpdateIdvReqStatusModelRequestDto: type: object properties: statuses: type: - array - 'null' items: $ref: '#/components/schemas/SingleIdvReqStatusRequestDto' description: The statuses of the Idv Requirements additionalProperties: false description: Contains the information needed to update the status of the Idv Requirement CreateIdvRequirementStatusModelRequestDto: type: object properties: entityId: type: string description: The Id of the Entity format: uuid example: 18c086ce-f3e1-4311-af6a-1c3fe4f6b6ba journeyId: type: string description: The Id of the Journey format: uuid example: 088f2d94-f2e1-4afb-b908-498a76ebf771 statuses: type: - array - 'null' items: $ref: '#/components/schemas/SingleIdvReqStatusRequestDto' description: The statuses of the Idv requirements additionalProperties: false description: Contains all the information needed to store the status of the Idv Requirement Model CreateSingleIdvRequirementStatusRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateSingleIdvRequirementStatusRequestDto' description: The service request DTO additionalProperties: false description: Service request data 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 MeasureCompletenessRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/MeasureCompletenessRequestDto' description: The service request DTO additionalProperties: false description: Service request data MeasureCompletenessRequestDto: type: object properties: id: type: string description: The Id of the existing Idv Requirement Status Model format: uuid example: b3b8b5c8-809a-462a-834b-64206522daa9 journeyId: type: string description: The Id of the Journey format: uuid example: 19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769 taskId: type: string description: The Id of the Task format: uuid example: d560c7bc-2e5d-449c-bd2a-07962fa2f755 entityId: type: string description: The Id of the Entity format: uuid example: 315df981-38a0-4145-836b-8d22745887b6 entityDraftId: type: string description: The Id of the EntityDraft format: uuid example: ed1c2720-568b-4ac1-b481-b3c4c24025b1 additionalProperties: false description: Request DTO representing object used to measure the completeness of Ownership and Control Idv Requirements CreateSingleIdvRequirementStatusRequestDto: type: object properties: entityId: type: string description: The Id of the Entity format: uuid example: 18c086ce-f3e1-4311-af6a-1c3fe4f6b6ba journeyId: type: string description: The Id of the Journey format: uuid example: 088f2d94-f2e1-4afb-b908-498a76ebf771 status: allOf: - $ref: '#/components/schemas/SingleIdvReqStatusRequestDto' description: Contains the data for updating an Idv Requirement Status additionalProperties: false description: Contains all the information needed to store the status of the Idv Requirement MeasureCompletenessStatusResponse: type: object properties: requirementId: type: - string - 'null' description: The Id of the Requirement example: 8d9e92eb-d18e-4d4d-8971-7781ccc31c80 requirementName: type: - string - 'null' description: The name of the Requirement example: Add 2 Directors status: type: - string - 'null' description: The status of the Requirement example: Completed ownershipAndControlDataKey: type: - string - 'null' description: The OwnershipAndControl DataKey example: addTwoDirectors completedDate: type: - string - 'null' description: The date at which the requirement was set to Complete format: date-time idvMinimumPartyCount: type: - integer - 'null' description: The Minimum Idv Party Count needed to validate the Requirement format: int32 example: 2 idvAllParties: type: - boolean - 'null' description: The attribute which specifies if all Related Parties that meet the criteria need to be Idv compliant example: false additionalProperties: false description: Contains all the information needed to store the status of the Completeness response UpdateIdvReqStatusModelRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateIdvReqStatusModelRequestDto' description: The service request DTO additionalProperties: false description: Service request 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 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 IdvReqStatusModelResponseDto: type: object properties: id: type: string description: The unique identifier of the model format: uuid example: 088f2d94-f2e1-4afb-b908-498a76ebf771 entityId: type: string description: The Id of the Entity format: uuid example: 18c086ce-f3e1-4311-af6a-1c3fe4f6b6ba journeyId: type: string description: The Id of the Journey format: uuid example: 088f2d94-f2e1-4afb-b908-498a76ebf771 statuses: type: - array - 'null' items: $ref: '#/components/schemas/IdvReqStatusResponseDto' description: The statuses of the Idv Requirements additionalProperties: false description: Contains all the information needed to store the status of the Idv Requirement IdvReqStatusResponseDto: type: object properties: requirementId: type: string description: The Id of the Requirement format: uuid example: 580565ee-0700-4aec-854d-8cc9dbb58bc1 status: type: - string - 'null' description: The Status of the Idv Requirement example: Completed ownershipAndControlDataKey: type: - string - 'null' description: The DataKey of the Requirement example: addAllUBOs completedDate: type: - string - 'null' description: The date when the Requirement was set to 'Completed' format: date-time example: null requirementName: type: - string - 'null' description: The Name of the Requirement example: Add All UBOs idvMinimumPartyCount: type: - integer - 'null' description: The Minimum Idv Party Count needed to validate the Requirement format: int32 example: 2 idvAllParties: type: - boolean - 'null' description: The attribute which specifies if all Related Parties that meet the criteria need to be Idv compliant example: false additionalProperties: false description: Contains all the information needed to store the status of the Idv Requirement CreateIdvRequirementStatusModelRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateIdvRequirementStatusModelRequestDto' description: The service request DTO additionalProperties: false description: Service request data MeasureCompletenessResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/MeasureCompletenessResponseDto' 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 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 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 - 'null' items: $ref: '#/components/schemas/IdvRequirementStatusDto' description: The statuses of the Idv Requirements additionalProperties: false description: Contains all the information needed to store the status of the Idv Requirement IdvRequirementStatusDto: type: object properties: requirementId: type: string description: The Id of the Requirement format: uuid example: 580565ee-0700-4aec-854d-8cc9dbb58bc1 status: type: - string - 'null' description: The Status of the Idv Requirement example: Complete ownershipAndControlDataKey: type: - string - 'null' description: The DataKey of the Requirement example: e28a3705-927b-47cd-98bc-b2ad63a6fa69 completedDate: type: - string - 'null' description: The date when the Requirement was set to 'Completed' format: date-time example: null requirementName: type: - string - 'null' description: The Name of the Requirement example: Add All UBOs idvMinimumPartyCount: type: - integer - 'null' description: The Minimum Idv Party Count needed to validate the Requirement format: int32 example: 2 idvAllParties: type: - boolean - 'null' description: The attribute which specifies if all Related Parties that meet the criteria need to be Idv compliant example: false additionalProperties: false description: Contains the data relating to an Idv Requirement Status IdvRequirementStatusResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/IdvRequirementStatusResponseDto' 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 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