openapi: 3.2.0
info:
  title: Fenergo E Signature API
  version: '1.0'
  description: 'Operations tagged ESignature across 2 of this provider''s published API definitions: fenergo-documentmanagementcommand-v1-0-openapi.json, fenergo-documentmanagementcommand-v2-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /documentmanagementcommand
security:
- Bearer: []
tags:
- name: ESignature
paths:
  /api/esignature:
    post:
      tags:
      - ESignature
      summary: Sends a request with documents to external provider for eSignature
      description: 'This method will send documents to external provider for eSignature


        Required permissions:

        Following permissions are required: DocumentManagementSendForSignature'
      operationId: SendDocumentsForSignature
      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 documents and mandatory signers to send
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DocumentSignatureRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DocumentSignatureRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DocumentSignatureRequestDtoServiceRequest'
      responses:
        '202':
          description: DocumentSignatureResponseDto model created successfully
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentSignatureResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentSignatureResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentSignatureResponseDtoServiceResponse'
        '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: /documentmanagementcommand
  /api/esignature/cancel:
    post:
      tags:
      - ESignature
      summary: Voids existing eSignature and resets document requirement status
      description: 'Required permissions:

        Following permissions are required: DocumentManagementEdit'
      operationId: CancelESignature
      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 documents and mandatory signers to send
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DocumentSignatureCancellationRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DocumentSignatureCancellationRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DocumentSignatureCancellationRequestDtoServiceRequest'
      responses:
        '202':
          description: Signature cancelled
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentSignatureCancellationResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentSignatureCancellationResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentSignatureCancellationResponseDtoServiceResponse'
        '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'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Document Requirement not 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: OBSOLETE_ENDPOINT
    servers:
    - url: /documentmanagementcommand
  /api/v2/esignature:
    post:
      tags:
      - ESignature
      summary: Sends a request with documents to external provider for eSignature
      description: 'This method will send documents to external provider for eSignature


        Required permissions:

        Following permissions are required: DocumentManagementSendForSignature'
      operationId: postApiV2Esignature
      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 documents and mandatory signers to send
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DocumentSignatureRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DocumentSignatureRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DocumentSignatureRequestDtoServiceRequest'
      responses:
        '202':
          description: DocumentSignatureResponseDto model created successfully
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentSignatureResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentSignatureResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentSignatureResponseDtoServiceResponse'
        '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: SendDocumentsForSignature
    servers:
    - url: /documentmanagementcommand
  /api/v2/esignature/cancel:
    post:
      tags:
      - ESignature
      summary: Voids existing eSignature and resets document requirement status
      description: 'Required permissions:

        Following permissions are required: DocumentManagementEdit'
      operationId: postApiV2EsignatureCancel
      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 documents and mandatory signers to send
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DocumentSignatureCancellationRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DocumentSignatureCancellationRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DocumentSignatureCancellationRequestDtoServiceRequest'
      responses:
        '202':
          description: Signature cancelled
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentSignatureCancellationResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentSignatureCancellationResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentSignatureCancellationResponseDtoServiceResponse'
        '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'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Document Requirement not 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: OBSOLETE_ENDPOINT
      x-operation-id-source: normalized
      x-operation-id-original: CancelESignature
    servers:
    - url: /documentmanagementcommand
components:
  schemas:
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    DocumentSignatureRequestDto:
      type: object
      properties:
        taskId:
          type: string
          description: The Id of the task
          format: uuid
          example: 315df981-38a0-4145-836b-8d22745887b6
        entityId:
          type: string
          description: The Id of the entity
          format: uuid
          example: 315df981-38a0-4145-836b-8d22745887b6
        journeyId:
          type: string
          description: The Id of the journey
          format: uuid
          example: 315df981-38a0-4145-836b-8d22745887b6
        entityName:
          type:
          - string
          - 'null'
          description: The name of entity
          example: Fenergo Limited
        providerName:
          type:
          - string
          - 'null'
          description: The name of external provider
          example: DocuSign
        documentRequirementsIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of document requirements identifiers which will be send
        signers:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SignerDto'
          description: List of persons required to sign off
        isDraft:
          type:
          - boolean
          - 'null'
          description: Flag which determines which status will be send to external provider
          example: false
      additionalProperties: false
      description: A document requirement model for external eSignature provider
    RecipientIdentityPhoneNumber:
      type: object
      properties:
        countryCode:
          type:
          - string
          - 'null'
        countryCodeLock:
          type:
          - string
          - 'null'
        countryCodeMetadata:
          allOf:
          - $ref: '#/components/schemas/PropertyMetadata'
        extension:
          type:
          - string
          - 'null'
        extensionMetadata:
          allOf:
          - $ref: '#/components/schemas/PropertyMetadata'
        number:
          type:
          - string
          - 'null'
        numberMetadata:
          allOf:
          - $ref: '#/components/schemas/PropertyMetadata'
      additionalProperties: false
    DocumentSignatureCancellationResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/DocumentSignatureCancellationResponseDto'
          description: A document requirement model for an external eSignature provider
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    DocumentSignatureCancellationResponseDto:
      type: object
      properties:
        warnings:
          type:
          - array
          - 'null'
          items:
            type: string
          description: The list of possible warnings
      additionalProperties: false
      description: A document requirement model for an external eSignature provider
    DocumentSignatureCancellationRequestDto:
      type: object
      properties:
        providerName:
          type:
          - string
          - 'null'
          description: The name of external provider
          example: DocuSign
        eSignatureDocumentRequirementId:
          type: string
          description: ESignatureDocumentRequirement identifier
          format: uuid
          example: 4ec8f1bc-d745-4d0d-a9e7-cde0d0e7a614
      additionalProperties: false
      description: A document requirement model for external eSignature provider
    DocumentSignatureCancellationRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/DocumentSignatureCancellationRequestDto'
          description: A document requirement model for external eSignature provider
      additionalProperties: false
    RecipientIdentityInputOption:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        phoneNumberList:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecipientIdentityPhoneNumber'
        valueType:
          type:
          - string
          - 'null'
      additionalProperties: false
    DocumentSignatureResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/DocumentSignatureResponseDto'
          description: A document requirement model for an external eSignature provider
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    DocumentSignatureResponseDto:
      type: object
      properties:
        envelopeId:
          type:
          - string
          - 'null'
          description: EnvelopeId attribute of the eSignature Document Requirement defined by eSignature Service
          example: 4ec8f1bc-d745-4d0d-a9e7-cde0d0e7a614
        dateSent:
          type:
          - string
          - 'null'
          description: The sent date to external eSignature service
          format: date-time
          example: '2021-09-09 09:26:03.478039'
        externalProviderUrl:
          type:
          - string
          - 'null'
          description: The URL which navigates to External Provider Envelope
          example: https://docusign.net/
        warnings:
          type:
          - array
          - 'null'
          items:
            type: string
          description: The list of possible warnings
      additionalProperties: false
      description: A document requirement model for an external eSignature provider
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    SignerDto:
      type: object
      properties:
        signerType:
          type:
          - string
          - 'null'
        fullName:
          type:
          - string
          - 'null'
        email:
          type:
          - string
          - 'null'
        relationship:
          type:
          - string
          - 'null'
        hasSigned:
          type:
          - boolean
          - 'null'
        order:
          type: integer
          format: int32
        accessCode:
          type:
          - string
          - 'null'
        recipientIdentityVerification:
          allOf:
          - $ref: '#/components/schemas/RecipientIdentityVerification'
        signatureType:
          type:
          - string
          - 'null'
        smsNumber:
          type:
          - string
          - 'null'
      additionalProperties: false
    RecipientIdentityVerification:
      type: object
      properties:
        inputOptions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RecipientIdentityInputOption'
        workflowId:
          type:
          - string
          - 'null'
        workflowIdMetadata:
          allOf:
          - $ref: '#/components/schemas/PropertyMetadata'
        workflowLabel:
          type:
          - string
          - 'null'
      additionalProperties: false
    PropertyMetadata:
      type: object
      properties:
        options:
          type:
          - array
          - 'null'
          items:
            type: string
        rights:
          type:
          - string
          - 'null'
      additionalProperties: false
    DocumentSignatureRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/DocumentSignatureRequestDto'
          description: A document requirement model for external eSignature provider
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-documentmanagementcommand-v1-0-openapi.json
- fenergo-documentmanagementcommand-v2-0-openapi.json