openapi: 3.2.0
info:
  title: Fenergo Collateral API
  version: '1.0'
  description: 'Operations tagged Collateral across 2 of this provider''s published API definitions: fenergo-collateralcommand-v1-0-openapi.json, fenergo-collateralquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /collateralcommand
- url: /collateralquery
security:
- Bearer: []
tags:
- name: Collateral
paths:
  /api/collateral:
    post:
      tags:
      - Collateral
      summary: Create a new Collateral
      description: 'Creates a new Collateral


        The returned Id can be used in the Query API to retrieve this Collateral.


        Required permissions:

        Following permissions are required: CollateralEdit'
      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: Create Collateral request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CollateralDtoServiceRequest'
      responses:
        '202':
          description: Success. Asset created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollateralDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: Error Code
      operationId: postApiCollateral
      x-operation-id-source: derived
    get:
      tags:
      - Collateral
      summary: Get all Collaterals for a Tenant Id
      description: 'This endpoint is obsolete and was terminated on 2023-09-30. This endpoint is obsolete, use GetCollateralsList instead.


        This method returns the list of Collaterals for the Tenant.


        Required permissions:

        Following permissions are required: CollateralAccessAndSearch'
      operationId: GetCollaterals
      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: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollateralDtoIEnumerableServiceResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: Error Code
      deprecated: true
    servers:
    - url: /collateralcommand
  /api/collateral/{id}:
    delete:
      tags:
      - Collateral
      summary: Delete a Collateral
      description: 'Deletes a Collateral and its drafts with any connected Assets and their drafts


        Only Collaterals with the draft status can be deleted.


        Required permissions:

        Following permissions are required: CollateralEdit'
      parameters:
      - name: id
        in: path
        description: Collateral Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '202':
          description: Accepted for processing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: Error Code
      operationId: deleteApiCollateralById
      x-operation-id-source: derived
    get:
      tags:
      - Collateral
      summary: Get a Collateral by Id
      description: 'This method returns the Collateral of specified Id.


        Required permissions:

        Following permissions are required: CollateralAccessAndSearch'
      operationId: GetCollateralById
      parameters:
      - name: id
        in: path
        description: Collateral Id
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollateralDtoServiceResponse_2'
        '400':
          description: Collateral Id is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: No Collateral was found
                  type: Error
                  errorCode: Error Code
        '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: Error Code
    servers:
    - url: /collateralcommand
  /api/collateral/journey/{journeyId}/task/{taskId}/entity/{entityId}/snapshot:
    post:
      tags:
      - Collateral
      summary: Save Collaterals snapshot in a given task
      description: 'This method saves an object containing lists of Collaterals and drafts in S3 for a given taskId


        Required permissions:

        Following permissions are required: CollateralEdit'
      parameters:
      - name: journeyId
        in: path
        description: Journey Id
        required: true
        schema:
          type: string
          format: uuid
      - name: taskId
        in: path
        description: Task Id
        required: true
        schema:
          type: string
          format: uuid
      - name: entityId
        in: path
        description: Entity Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '202':
          description: Success. Collaterals snapshot saved
        '500':
          description: Internal server error
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/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
        '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: Error Code
      operationId: postApiCollateralJourneyByJourneyIdTaskByTaskIdEntityByEntityIdSnapshot
      x-operation-id-source: derived
    servers:
    - url: /collateralcommand
  /api/collateral/getCollateralsList:
    post:
      tags:
      - Collateral
      summary: Get Collaterals with specified attributes
      description: 'This method returns Collaterals with attributes specified.


        Required permissions:

        Following permissions are required: CollateralAccessAndSearch'
      operationId: GetCollateralsList
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CollateralQueryDtoServiceRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollateralDtoListServiceResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: An exception occurred while processing the request
        '202':
          description: Success. Collaterals are returned
        '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: Error Code
    servers:
    - url: /collateralquery
  /api/collateral/journey/{journeyId}/task/{taskId}/snapshot:
    get:
      tags:
      - Collateral
      summary: Get Collaterals snapshot for the given Task
      description: 'This method retrieves an object containing lists of Collaterals and drafts from S3 for a given taskId


        Required permissions:

        Following permissions are required: CollateralAccessAndSearch'
      operationId: GetCollateralsSnapShot
      parameters:
      - name: journeyId
        in: path
        description: The id of a Journey that the Collaterals belong to
        required: true
        schema:
          type: string
          format: uuid
      - name: taskId
        in: path
        description: The id of a Task that the Collaterals belong to
        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:
            application/json:
              schema:
                $ref: '#/components/schemas/CollateralSnapshotDtoServiceResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: An exception occurred while processing the query
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '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: Error Code
    servers:
    - url: /collateralquery
  /api/collateral/journey/{journeyId}/validateAllocation:
    post:
      tags:
      - Collateral
      summary: Validate Deal Collateral Allocation
      description: 'This method validate collaterals allocations that attached to deals


        Required permissions:

        Following permissions are required: CollateralAccessAndSearch'
      operationId: ValidateDealCollateralAllocation
      parameters:
      - name: journeyId
        in: path
        description: Journey Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Validate collateral allocation request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ValidateDealCollateralAllocationRequestDtoServiceRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateDealCollateralAllocationResponseDtoServiceResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: An exception occurred while processing the query
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '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: Error Code
    servers:
    - url: /collateralquery
  /api/collateral/related-collateral/entity/{entityId}/journey/{journeyId}:
    get:
      tags:
      - Collateral
      summary: Get Related Collaterals Data Source
      description: 'This method retrieves related collaterals data source for a journey


        Required permissions:

        Following permissions are required: CollateralAccessAndSearch'
      operationId: GetRelatedCollateralDataSource
      parameters:
      - name: entityId
        in: path
        description: The Id of the existing Entity
        required: true
        schema:
          type: string
          format: uuid
      - name: journeyId
        in: path
        description: The Id of the existing Journey
        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:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourcesLambdaResponseServiceResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: An exception occurred while processing the query
        '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: Error Code
    servers:
    - url: /collateralquery
components:
  schemas:
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    PropertyType:
      enum:
      - Single
      - Custom
      - Collection
      type: string
    CollateralDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CollateralDto2'
          description: "Class to represent the collateral uploaded. \nContains all properties needed to fill the metadata of the collateral being uploaded."
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    PropertyDto:
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          readOnly: true
        discriminator:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          readOnly: true
        isValid:
          type:
          - boolean
          - 'null'
      additionalProperties: false
    CollateralDto2:
      type: object
      properties:
        id:
          type: string
          description: The Collateral Id
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        type:
          type:
          - string
          - 'null'
          description: The Collateral Type
          example: Financial Asset
        alternateId:
          type:
          - string
          - 'null'
          description: Collateral Id from data migration
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: 'List of custom properties for a collateral separate from the standard

            out of the box properties.'
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Spain
                    city: Madrid
                    street: C. de Sevilla
                93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2:
                  properties:
                    country: Spain
                    city: Barcelona
                    street: Carrer de Girona
        entityId:
          type: string
          description: The Entity Id
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        journeyId:
          type: string
          description: The Journey Id
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        created:
          type:
          - string
          - 'null'
          description: The creation date of the Collateral
          format: date-time
      additionalProperties: false
      description: "Class to represent the collateral uploaded. \nContains all properties needed to fill the metadata of the collateral being uploaded."
    CollateralDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CollateralDto2'
          description: "Class to represent the collateral uploaded. \nContains all properties needed to fill the metadata of the collateral being uploaded."
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    PropertiesDto:
      type: object
      properties:
        singleProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto2'
        collectionProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CollectionPropertyDto2'
        customProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CustomPropertyDto2'
      additionalProperties: false
    CollateralDtoIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CollateralDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    DataSourcesDto:
      type: object
      properties:
        entityDataMetadata:
          allOf:
          - $ref: '#/components/schemas/EntityDataMetadataDataSource'
        eventIngress:
          allOf:
          - $ref: '#/components/schemas/EventIngressDataSource'
        changedFields:
          allOf:
          - $ref: '#/components/schemas/ChangedFieldsDataSource'
        relatedClient:
          allOf:
          - $ref: '#/components/schemas/RelatedClientDataSource'
        relatedProducts:
          allOf:
          - $ref: '#/components/schemas/RelatedProductsDataSource'
        currentDataGroupItem:
          allOf:
          - $ref: '#/components/schemas/CurrentDataGroupItemDataSource'
        externalDataAdapter:
          allOf:
          - $ref: '#/components/schemas/ExternalDataAdapterDataSource'
        entityAssociation:
          allOf:
          - $ref: '#/components/schemas/EntityAssociationDataSource'
        manualCreditAssessment:
          allOf:
          - $ref: '#/components/schemas/ManualCreditAssessmentV2DataSource'
        autoCreditAssessment:
          allOf:
          - $ref: '#/components/schemas/AutoCreditAssessmentDataSource'
        manualCreditScreening:
          allOf:
          - $ref: '#/components/schemas/ManualCreditScreeningDataSource'
        collateral:
          allOf:
          - $ref: '#/components/schemas/CollateralDataSource'
        currentJourneys:
          allOf:
          - $ref: '#/components/schemas/CurrentJourneysDataSource'
        autoCreditScreening:
          allOf:
          - $ref: '#/components/schemas/AutoCreditScreeningDataSource'
        currentProduct:
          allOf:
          - $ref: '#/components/schemas/CurrentProductDataSource'
        relatedDeals:
          allOf:
          - $ref: '#/components/schemas/RelatedDealsDataSource'
        mainEntity:
          allOf:
          - $ref: '#/components/schemas/MainEntityDataSource'
        relatedAssets:
          allOf:
          - $ref: '#/components/schemas/RelatedAssetsDataSource'
        relatedAssociations:
          allOf:
          - $ref: '#/components/schemas/RelatedAssociationsDataSource'
        accountRelatedFunds:
          allOf:
          - $ref: '#/components/schemas/AccountRelatedFundsDataSource'
        journeyLevelData:
          allOf:
          - $ref: '#/components/schemas/JourneyLevelDataDataSource'
        relatedParties:
          allOf:
          - $ref: '#/components/schemas/RelatedPartiesDataSource'
        currentField:
          allOf:
          - $ref: '#/components/schemas/CurrentFieldDataSource'
        significanceEngine:
          allOf:
          - $ref: '#/components/schemas/SignificanceEngineDataSource'
      additionalProperties: false
    CurrentJourneysDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        inProgressJourneyTypes:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    EntityAssociationDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        associationType:
          type:
          - string
          - 'null'
        ownershipPercentage:
          type:
          - number
          - 'null'
          format: double
        associationToClient:
          type:
          - string
          - 'null'
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    CurrentFieldDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        currentField:
          type:
          - string
          - 'null'
      additionalProperties: false
    SignificanceEngineDto:
      type: object
      properties:
        singleFields:
          type:
          - array
          - 'null'
          items:
            type: string
        collections:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - object
            - 'null'
            additionalProperties:
              type: array
              items:
                type: string
      additionalProperties: false
    AutoCreditScreeningDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        creditScreenings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AutoCreditScreeningDto'
        relatedPartyCreditScreenings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AutoCreditScreeningDto'
      additionalProperties: false
    SignificanceEngineDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        significanceEngine:
          allOf:
          - $ref: '#/components/schemas/SignificanceEngineDto'
      additionalProperties: false
    CollateralSnapshotDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CollateralSnapshotDto'
          description: A Collateral snapshot object
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    CollateralQueryDto:
      type: object
      properties:
        ids:
          type:
          - array
          - 'null'
          items:
            type: string
          description: The list of Collateral Ids to fetch
        attributes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: The list of attributes to fetch the data for
      additionalProperties: false
    RelatedProductDto:
      type: object
      properties:
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
        lifecycleStatus:
          type:
          - string
          - 'null'
        relationshipTypes:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    JourneyLevelDataDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    AutoCreditScreeningDto:
      type: object
      properties:
        entityId:
          type: string
          format: uuid
        creditScreeningOutcome:
          type:
          - string
          - 'null'
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
        providerInternalIdentifier:
          type:
          - string
          - 'null'
      additionalProperties: false
    DataSourcesLambdaResponseServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/DataSourcesLambdaResponse'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    AutoCreditAssessmentDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        autoCreditAssessments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AutoCreditAssessmentDto'
      additionalProperties: false
    RelatedAssociationsDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        relatedAssociations:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RelatedAssociationDto'
      additionalProperties: false
    ValidateDealCollateralAllocationResponseDto:
      type: object
      properties:
        allocationValidationResult:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/AllocationValidationResultDto'
      additionalProperties: false
    CollateralSnapshotDto:
      type: object
      properties:
        collaterals:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CollateralDto'
          description: List of Collaterals
        collateralDrafts:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CollateralDraftDto'
          description: List of Collateral drafts
      additionalProperties: false
      description: A Collateral snapshot object
    EntityDataMetadataDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        entityType:
          type:
          - string
          - 'null'
      additionalProperties: false
    ManualCreditScreeningDto:
      type: object
      properties:
        taskDataKey:
          type:
          - string
          - 'null'
        taskId:
          type: string
          format: uuid
        entityId:
          type: string
          format: uuid
        creditScreeningOutcome:
          type:
          - string
          - 'null'
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
      additionalProperties: false
    ManualCreditAssessmentV2DataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        creditAssessments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CreditAssessmentDto'
      additionalProperties: false
    RelatedClientDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
      additionalProperties: false
    RelatedPartyDto:
      type: object
      properties:
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
        metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
      additionalProperties: false
    ValidateDealCollateralAllocationResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ValidateDealCollateralAllocationResponseDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    CollateralDto2_2:
      type: object
      properties:
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
      additionalProperties: false
    ChangedFieldsDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        changedFields:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ChangedFieldDto'
      additionalProperties: false
    DataSourcesLambdaResponse:
      type: object
      properties:
        dataSources:
          allOf:
          - $ref: '#/components/schemas/DataSourcesDto'
      additionalProperties: false
    ValidateDealCollateralAllocationRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ValidateDealCollateralAllocationRequestDto'
          description: Class to represent the collaterals allocations validations input
      additionalProperties: false
    CollateralDto:
      type: object
      properties:
        id:
          type: string
          description: The Collateral Id
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        type:
          type:
          - string
          - 'null'
          description: The Collateral Type
          example: Financial Asset
        alternateId:
          type:
          - string
          - 'null'
          description: Collateral Id from data migration
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: 'List of custom properties for a collateral separate from the standard

            out of the box properties.'
        lifecycleStatus:
          type:
          - string
          - 'null'
          description: The lifecycle status of the collateral
        created:
          type:
          - string
          - 'null'
          description: The creation date of the Collateral
          format: date-time
      additionalProperties: false
      description: "Class to represent the collateral uploaded. \nContains all properties needed to fill the metadata of the collateral being uploaded."
    ValidationErrorDto:
      type: object
      properties:
        property:
          type:
          - string
          - 'null'
        validator:
          type:
          - string
          - 'null'
        message:
          type:
          - string
          - 'null'
      additionalProperties: false
    AccountRelatedFundDto:
      type: object
      properties:
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    CreditAssessmentDto:
      type: object
      properties:
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
        assessmentOutcome:
          type:
          - string
          - 'null'
        assessmentComment:
          type:
          - string
          - 'null'
        taskId:
          type:
          - string
          - 'null'
        taskDataKey:
          type:
          - string
          - 'null'
      additionalProperties: false
    CollectionItemDto:
      type: object
      properties:
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto2'
      additionalProperties: false
    CollectionPropertyDto2:
      type: object
      properties:
        items:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CollectionItemDto'
        collectionId:
          type:
          - string
          - 'null'
          format: uuid
      additionalProperties: false
    RelatedDealsDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        relatedDeals:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RelatedDealDto'
      additionalProperties: false
    RelatedDealDto:
      type: object
      properties:
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
      additionalProperties: false
    CollateralDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        collaterals:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CollateralDto2_2'
      additionalProperties: false
    RelatedAssociationDto:
      type: object
      properties:
        associationType:
          type:
          - string
          - 'null'
        ownershipPercentage:
          type:
          - number
          - 'null'
          format: double
        associationToClient:
          type:
          - string
          - 'null'
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    RelatedAssetDto:
      type: object
      properties:
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
      additionalProperties: false
    AutoCreditAssessmentDto:
      type: object
      properties:
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
        assessmentOutcome:
          type:
          - string
          - 'null'
        providerInternalIdentifier:
          type:
          - string
          - 'null'
      additionalProperties: false
    RelatedProductsDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        products:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RelatedProductDto'
      additionalProperties: false
    AccountRelatedFundsDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        accountRelatedFunds:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AccountRelatedFundDto'
      additionalProperties: false
    MainEntityDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    CurrentProductDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
        lifecycleStatus:
          type:
          - string
          - 'null'
      additionalProperties: false
    CollateralQueryDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CollateralQueryDto'
      additionalProperties: false
    VersionedJurisdictionDto:
      type: object
      properties:
        Jurisdiction:
          type:
          - string
          - 'null'
        VersionId:
          type:
          - string
          - 'null'
          format: uuid
      additionalProperties: false
    CollateralDraftDto:
      type: object
      properties:
        id:
          type: string
          description: The Collateral Draft Id
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        type:
          type:
          - string
          - 'null'
          description: The Collateral Type
          example: Financial Asset
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: 'List of custom properties for a collateral separate from the standard

            out of the box properties.'
        status:
          type:
          - string
          - 'null'
          description: The Collateral Draft Status
          example: Active
        sourceCollateralVersion:
          type: integer
          description: The Version of Collateral that draft was made for
          format: int32
          example: 1
        sourceCollateralId:
          type: string
          description: The Collateral Id
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        journeyId:
          type: string
          description: Id of the related Journey
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        version:
          type: integer
          description: Version of the Collateral Draft
          format: int32
        createdDate:
          type:
          - string
          - 'null'
          description: DateTime of the created Collateral
          format: date-time
      additionalProperties: false
      description: "A Collateral object. \nContains all properties needed to fill the metadata of the collateral."
    ManualCreditScreeningDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        creditScreenings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ManualCreditScreeningDto'
        relatedPartyCreditScreenings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ManualCreditScreeningDto'
      additionalProperties: false
    CollateralDtoListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CollateralDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    SinglePropertyDto2:
      type: object
      properties:
        value:
          type:
          - string
          - 'null'
        valueId:
          type:
          - string
          - 'null'
      additionalProperties: false
    AllocationValidationResultDto:
      type: object
      properties:
        collateralId:
          type:
          - string
          - 'null'
        collateralType:
          type:
          - string
          - 'null'
        isValid:
          type: boolean
        errorMessages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationErrorDto'
      additionalProperties: false
    EventIngressDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        eventType:
          type:
          - string
          - 'null'
        eventSubtype:
          type:
          - string
          - 'null'
      additionalProperties: false
    CustomPropertyDto2:
      type: object
      properties:
        singleProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto2'
        customProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CustomPropertyDto2'
      additionalProperties: false
    ChangedFieldDto:
      type: object
      properties:
        key:
          type:
          - string
          - 'null'
      additionalProperties: false
    ValidateDealCollateralAllocationRequestDto:
      type: object
      properties:
        dealIds:
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
          description: Deal Ids
        jurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto'
          description: Jurisdictions that apply to current entity
        entityType:
          type:
          - string
          - 'null'
          description: Entity type
          example: Individual
        categories:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Deal Collateral Categories
      additionalProperties: false
      description: Class to represent the collaterals allocations validations input
    RelatedPartiesDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        relatedParties:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RelatedPartyDto'
      additionalProperties: false
    ExternalDataAdapterDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        eventType:
          type:
          - string
          - 'null'
        eventSubtype:
          type:
          - string
          - 'null'
      additionalProperties: false
    RelatedAssetsDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        assets:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RelatedAssetDto'
      additionalProperties: false
    CollateralDtoServiceResponse_2:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CollateralDto'
          description: "Class to represent the collateral uploaded. \nContains all properties needed to fill the metadata of the collateral being uploaded."
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    CurrentDataGroupItemDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-collateralcommand-v1-0-openapi.json
- fenergo-collateralquery-v1-0-openapi.json