FLEXBridge Document Service API

FLEXBridge 2025 FLEXBridge API Documents FLEXBridge Document Service API

This document provides comprehensive technical documentation for the FlexBridge Document Service API, a RESTful API designed for searching, retrieving, and storing documents within the Flex system’s document database (www.flexcutech.com). All documents stored within the FLEX system are in PDF format.

1. Introduction to FlexBridge Document Service API

The Document Service API facilitates interaction with the Credit Union’s document database. It allows for efficient management of digital documents, including external documents through the DocDrop process.

  • Available FLEX Releases: 8.05
  • Document Service API Version: 1.151 and up

2. General API Information

  • RESTful API: Follows RESTful principles for communication.
  • Authentication: Requires built-in authentication via HTTPS request headers. Refer to the FLEX Core System documentation for information on how to add authentication headers.
  • Document Format: All documents stored within the FLEX system are in PDF format.

3. Bridge API Functions

The FlexBridge Document Service API offers the following core functions:

  • Search Document
  • Retrieve Document
  • DocDrop Process (Store Document)

4. Search Document

This function allows you to search for member documents within the Credit Union’s document database.

  • POST Method:
    • URL: https://{URL/IP_ADDRESS}/api/documentmanager/search?tellerID={TELLER_ID_VALUE}&workstationID={WORKSTATION_ID_VALUE}
    • URL Parameters (Optional):
      • {TELLER_ID_VALUE} (String): Teller ID being used to search for documents.
      • {WORKSTATION_ID_VALUE} (String): Workstation ID being used to search for documents.
    • JSON Body Filter Options (Optional, but recommended for specific searches):
      • reportId (String): Credit Union defined Report ID, indicating the type of document. Max 10 chars.
      • accountNumber (Number): Account number for member. Max 9 chars. (Required if taxId is not sent).
      • suffix (Number): Subaccount/suffix for the member account or specified document. Max 3 chars.
      • fromDate (Date – MM/DD/CCYY or CCYY-MM-DD): Provides documents from this date up to the current system date. Can be used alone or with toDate.
      • toDate (Date – MM/DD/CCYY or CCYY-MM-DD): Provides documents prior to and equal to this date. Can be used alone or with fromDate.
      • taxId (Number): Member Tax ID. Max 9 chars. (Required if accountNumber is not sent).
      • group (String): Credit Union defined document group ID. Max 4 chars.
  • Response Object (documents):
    {
      “documents”: [
        {
          “documentId”: 2616209,
          “accountNumber”: 112963,
          “suffixNumber”: 0,
          “numberOfPages”: 1,
          “documentDate”: “09/13/2022 00:00:00 MDT”,
          “archivedTime”: null,
          “hasNotes”: true,
          “documentKey”: “RECIPT1”,
          “docmanIndex1”: “ADUEA”,
          “docmanIndex2”: “201”,
          “docmanIndex3”: 4167.00,
          “docmanIndex4”: 2662.00
        }
      ],
      “success”: true
    }

    • documents (List of Objects): Contains details of documents matching search filters.

5. Retrieve Document

This function retrieves a document stored in the Credit Union’s document database. The response provides a link to pull up the PDF document.

  • GET Method:
    • URL: https://{URL/IP_ADDRESS}/api/documentmanger/retrievedocument/{DOCUMENT_ID}?tellerID={TELLER_ID}&workstationID={WORKSTATION_ID}
    • Parameters:
      • {DOCUMENT_ID} (Required, String): Document ID associated with the document to be retrieved.
      • {TELLER_ID} (Optional, String): Teller ID being used to retrieve documents.
      • {WORKSTATION_ID} (Optional, String): Workstation ID being used to retrieve documents.
  • Response (javax.ws.rs.core.Response):
    • A successful request will send a link back to the PDF or the PDF document itself in the response. An unsuccessful request will return an error message.

6. DocDrop Process (Store Document)

The DocDrop Service allows third parties to place documents into a Shared Folder location for archiving into a Credit Union’s document database. This process requires a PDF file and a corresponding text indexing (.idx) file.

6.1. Setting Up the Process

  • Credit Union Responsibilities:
    • Creates the Shared Folder Location.
    • Creates all Report IDs used in the archival process.
    • Ensures Shared Folder location permissions allow the Linux script to read, execute, and modify files.
  • Third-Party Responsibilities:
    • Provides each PDF document’s indexing file (.idx) with required FLEX attributes.
    • Ensures PDF and indexing files are placed in the Shared Folder and have matching naming conventions (excluding the file extension).
  • FLEX Responsibilities:
    • Sets up and deploys the Document Drop Service to the Credit Union’s FLEXBridge Server.
    • Creates a custom Linux script to pull PDFs and indexes from the Shared Folder daily.

6.2. How the Process Works

  1. Document Placement: The third-party places PDF documents and their corresponding .idx files into the designated Shared Folder location.
  2. Daily Script Execution: Each day, the Linux script runs to move all items from the Shared Folder to the Credit Union’s FLEXBridge server.
  3. Indexing and Archiving: The Document Drop Service reads the indexing file information and moves the PDF document into the Credit Union’s Document Manager Database.

6.3. Output Image and Index File Names

  • The Document Archiving Services do not rely on the naming convention assigned by the third-party, only that the PDF and .idx files have matching names (e.g., NewAccountPacket_60798291.pdf and NewAccountPacket_60798291.idx).
  • The reportId attribute within the indexing file is used to archive the PDF into the database.

6.4. Indexing File Requirements

FLEX requires a text file with a .idx suffix for each PDF document. This file must contain the following attributes on separate lines, without delimiters:

  • reportId (Required, String): Credit union defined value for archiving documents. Max 10 chars.
  • reportDate (Required, Date – MM/DD/CCYY): Date document will be indexed under.
  • accountNumber (Required/Optional, Number): Account number. Max 9 chars. (Optional if taxId is sent).
  • taxId (Required/Optional, Number): Tax ID. Max 9 chars. (Optional if accountNumber is sent).
  • tellerId (Required, String): Teller ID to be stored with documents. Max 4 chars.
  • suffix (Optional, Number): Suffix number to store document under. Max 3 chars.
  • numberOfPages (Optional, Number): Number of pages in the document. Max 3 chars.

6.5. Report ID Index Information

  • Purpose: The Report ID (also known as User Data) is a Credit Union-created document description used by FLEX to store documents. It aids in sorting documents into searchable groups (e.g., LOANDOCS, MEMBDOCS, ADVA).
  • Creating a Report ID in FLEX:
    1. In the FLEX Main Menu, type “document” or “document manager”.
    2. Select “Document Manager Configuration”.
    3. Click the “Add” button (across from “Spool File Cross-Reference List Heading”).
    4. Fill out required fields, ensuring “User Data” matches your desired Report ID.
    5. Save the entry.
      • Note: You can also create a “Report Group” under the “Document group” option for easier filtering and searching.

6.6. Missing Documents and Invalid Document Log Reports

  • Reason for Missing Documents: Documents may not display in Document Manager if they fail to archive correctly due to missing or invalid index attributes.
  • DMINVALID User Data: FLEX archives failed documents under the User Data DMINVALID in Document Manager. These documents remain there until updated by the Credit Union.
  • Invalid Document Log Reports: The DocDrop Service creates daily log reports (stored on the Credit Union’s server at /flex/logs/dmimport/{YEAR}/{MONTH}) that indicate any document archiving issues. These logs are not stored in the Document Manager database.
    • Checking Logs: It is recommended to check these logs frequently. If no log exists for a given day, all documents archived correctly.
    • Troubleshooting: The logs detail why a document failed (e.g., incorrect Account Number, Tax ID, Teller ID).
  • Reindexing and Reassigning Documents in Document Manager:
    1. Filter: Navigate to Document Manager, click “Filter,” select DMINVALID from the “User Data” dropdown, and choose a date range.
    2. Reindex/Reassign: Right-click on a document in the filtered results to select “Reindex Document(s)” or “Reassign Document Type For Selected Document(s)”.
    3. Update Details: Populate custom indexes (optional) and reassign the document type (e.g., from DMINVALID to LOANDOCS). You can also add or change Account Number or Suffix.
    4. Click “OK” to save changes.

7. Object References

  • documents Object:
    • Attributes: documentId, accountNumber, suffixNumber, numberOfPages, documentDate, archivedTime, hasNotes, documentKey (Report ID/Userdata Spool Value), docmanIndex1-4 (Credit Union defined indexes).

8. FLEX Validation Checks Included in HTTPS Status Code 500 Error

Flex provides additional information in 500 HTTP Status Code errors for troubleshooting. These errors typically result from invalid attribute values or misconfigurations in the Credit Union’s database.

  • Common Error Message:
    • “message”: “Internal server error – The file does not exists in Document Manager”: Occurs when the document service cannot retrieve requested document information. Review values before resubmitting.
  • Troubleshooting Tip: Provide the exact error message to your Credit Union’s Flex support for efficient troubleshooting. They are typically familiar with these messages and how to correct the underlying data.