Fincura EmbeddedDocument API

openapi: 3.2.0
info:
  title: Automated Spreading and Analysis Api-Key Embedded Document API
  version: 1.3.1
  description: "This [REST API](https://en.wikipedia.org/wiki/Representational_state_transfer) allows you to interact with the Automated Spreading processing and insights engine. \n\n# Authentication\n\nThis API uses API keys generated from a Automated Spreading User account. To get access to your User account, speak with your Automated Spreading account manager.\n\n# Accepted Media Types\n\n| File Type      | Extension(s)     | Content-Type(s) |\n| -------------------------------- |-------------- | ------------ |\n| PDF File | .pdf | `application/pdf` , `application/x-pdf` |\n| Excel File | .xls | `application/vnd.ms-excel`  |\n| Excel File | .xlsx | `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`  |\n| Excel File | .xlsm | `application/vnd.ms-excel.sheet.macroEnabled.12`  |\n| PNG Image | .png | `image/png`  |\n| GIF Image | .gif | `image/gif`  |\n| JPG Image | .jpg, .jpeg | `image/jpeg`  |\n| GIF Image | .gif | `image/gif`  |\n| JSON File | .json | `application/json`  |\n\n\n# Getting Started\n\n1. [Create a Borrower](#operation/createBorrower) \n2. [Add a file](#operation/createDocumentFile) for that Borrower.\n3. Analyze in the Automated Spreading App\n\n****"
  x-logo:
    url: https://manual-public-web-static-resources.s3.amazonaws.com/public-api/Moodys-icon.svg
  contact:
    name: Moody's Automated Spreading Customer Support
    email: MA_NMR_Support@moodys.com
servers:
- url: https://api.fincura.com
  description: Base URL declared by the provider in apis.yml (roadmap#122).
security:
- API_Key: []
tags:
- name: EmbeddedDocument
  description: Embedded Document Workflows enable a 3rd party user to use the Fincura UI to complete a portion of our document parsing pipeline and then return to the 3rd parties website.
paths:
  /v1/embedded-workflow/{uuid}:
    get:
      operationId: retrieveEmbeddedWorkflow
      description: ''
      parameters:
      - name: uuid
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedWorkflow'
          description: ''
      tags:
      - EmbeddedDocument
  /v1/embedded-workflow:
    post:
      operationId: createEmbeddedWorkflow
      description: Returns a URL to an HTML webapp to complete document parsing pipeline flow
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddedWorkflow'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EmbeddedWorkflow'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EmbeddedWorkflow'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedWorkflow'
          description: ''
      tags:
      - EmbeddedDocument
components:
  schemas:
    EmbeddedWorkflow:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
          readOnly: true
        document_file_uuid:
          type: string
          format: uuid
          description: UUID of the DocumentFile for this workflow
        embed_type:
          enum:
          - IFRAME
          - NONE
          type: string
        created_date:
          type: string
          format: date-time
          readOnly: true
        exit_step:
          enum:
          - TABLE_ID
          - COLUMN_ID
          - REVIEW
          - SPREAD
          type: string
        redirect_url:
          type:
          - string
          - 'null'
          format: uri
          maxLength: 2500
          pattern: "^(?:[a-z0-9.+-]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)(?:\\.(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)){3}|\\[[0-9a-f:.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::[0-9]{1,5})?(?:[/?#][^\\s]*)?\\z"
        ui_controls:
          type: object
          properties:
            primary_button_color:
              type:
              - string
              - 'null'
              maxLength: 50
            complete_button_label:
              type:
              - string
              - 'null'
              maxLength: 20
            show_exit_button:
              type: boolean
        loaded:
          type: boolean
          readOnly: true
        load_workflow_url:
          type: string
          format: uri
          readOnly: true
          pattern: "^(?:[a-z0-9.+-]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)(?:\\.(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)){3}|\\[[0-9a-f:.]+\\]|([a-z¡-\uFFFF0-9](?:[a-z¡-\uFFFF0-9-]{0,61}[a-z¡-\uFFFF0-9])?(?:\\.(?!-)[a-z¡-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z¡-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::[0-9]{1,5})?(?:[/?#][^\\s]*)?\\z"
        external_user_id:
          type:
          - string
          - 'null'
          description: Id to identify the user performing the work (e.g. email or username)
          maxLength: 255
        external_user_label:
          type:
          - string
          - 'null'
          description: Human readable label to identify the user performing the work (e.g. name)
          maxLength: 255
      required:
      - document_file_uuid
  securitySchemes:
    API_Key:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-tagGroups:
- name: Tenant
  tags:
  - Api-Key
  - TenantSettings
- name: Templates
  tags:
  - SpreadingTemplate
  - DscrTemplate
  - GlobalCashflowTemplate
- name: Borrower
  tags:
  - Borrowers
  - Files
  - Loans
  - Requirements
  - Portfolios
- name: Normalized Data
  tags:
  - DataViews
  - Templates
- name: Analysis
  tags:
  - DscrAnalysis
  - GlobalCashflowAnalysis
- name: Events
  tags:
  - Webhooks
- name: Embedded UI
  tags:
  - EmbeddedDocument
  - EmbeddedFinancials
  - EmbeddedDscrAnalysis
  - EmbeddedGlobalCashflowAnalysis