FLEXBridge Share Service API

FLEXBridge 2025 FLEXBridge API Documents FLEXBridge Share Service API

This document provides comprehensive technical documentation for the FlexBridge Share Service API, a RESTful API designed for creating and closing secondary member share suffixes within the Flex system (www.flexcutech.com). This API is essential for Credit Union staff and integrated systems needing to programmatically manage checking, draft, money market, and other share accounts.

1. Introduction to FlexBridge Share Service API

The Share Service API is a portion of FLEXBridge that provides functions for creating secondary member share suffixes (e.g., checking, draft, money market) and closing existing share suffixes. It includes objects and attributes for defining information about the share, Joint Owner, Authorized Signer, and Beneficiary.

  • Available FLEX Releases: 8.05 and up
  • Share Service API Release: 1.67 or higher

2. General API Information

  • RESTful API: Follows RESTful principles for communication.
  • Authentication: Requires built-in authentication via HTTP request headers. Refer to the FLEX Core System documentation for information on how to add authentication headers.

3. FLEXBridge Functions

The FlexBridge Share Service API offers the following options for managing secondary share suffixes:

  • opensharesuffix (Quick Open): A quick option for opening a secondary share suffix with limited attributes. Requires the Credit Union to maintain additional information in FLEX upon successful request.
  • opennewshare (Expanded Option): An expanded option for opening a secondary share suffix. Includes various attributes and overdrafting information, and allows for adding a Joint Owner, Beneficiary, and Authorized Signer.
  • closesharesuffix: An option to close an existing member share suffix with a zero balance.

4. API Endpoints and Methods

All share suffix management functions are performed using POST requests.

4.1. Opening a Share Suffix – Quick Open (opensharesuffix)

Creates a new share suffix using limited attribute options to an existing Member account.

  • POST Method:
    • URL: https://{BASE_URL}/api/accountmanagement/opensharesuffix?tellerID={TELLER_ID}&workstation={WORKSTATION_ID}
    • URL Parameters (Optional):
      • tellerID (String): Credit Union defined Teller ID.
      • workstation (String): Credit Union defined Workstation ID.
    • JSON Body Attributes:
      • accountNumber (Required, Number): Member account number. Max 9 chars.
      • shareType (Required, String): Credit union defined share type. Max 3 chars.
      • suffixNumber (Optional, Number): Credit union defined suffix value. If not included, FLEX assigns the next available. Max 3 chars.
      • description (Optional, String): Description of the share. Max 16 chars.
  • Response Attributes:
    • success (Boolean): Indicates if the request was successful.
    • suffixNumber (Number): Suffix number used for the share suffix added.
    • description (String): Description for share suffix added.

4.2. Open New Share Suffix – Expanded Options (opennewshare)

Creates a new share suffix to an existing Member account with additional attributes and allows for adding Joint Owners, Authorized Signers, or Beneficiaries.

  • POST Method:
    • URL: https://{BASE_URL}/api/accountmanagement/opennewshare?tellerID={TELLER_ID}&workstation={WORKSTATION_ID}
    • URL Parameters (Optional):
      • tellerID (String): Credit Union defined Teller ID.
      • workstation (String): Credit Union defined Workstation ID.
    • Available JSON Body Objects:
      • share (Required, Object): Contains essential share information.
      • jointOwners (Optional, List): List of Joint Owners to be added.
      • authorizedSigners (Optional, List): List of Authorized Signers to be added.
      • beneficiaries (Optional, List): List of Beneficiaries to be added.

4.3. Close Share Suffix (closesharesuffix)

Closes an existing Member share suffix. The suffix balance must be zero at the time of the request.

  • POST Method:
    • URL: https://{BASE_URL}/api/accountmanagement/closesharesuffix?tellerID={TELLER_ID}&workstation={WORKSTATION_ID}
    • URL Parameters (Optional):
      • tellerID (String): Credit Union defined Teller ID.
      • workstation (String): Credit Union defined Workstation ID.
    • JSON Body Attributes:
      • accountNumber (Required, Number): Account number.
      • suffixNumber (Required, Number): Suffix number.
      • reasonCode (Optional, String): Credit union defined close reason. Max 3 chars.
  • Response Attribute (success):
    {
      “success”: true // Indicates if the request was successful.
    }

5. Object References (Detailed Attributes)

5.1. share Object (for opennewshare)

Contains essential share information for opening a new share suffix.

  • Attributes:
    • shareType (Required, String): Credit union defined share type value. Max 2 chars.
    • suffixNumber (Optional, Number): Credit union defined suffix value. Max 3 chars.
    • description (Optional, String): Description of base share. Max 16 chars.
    • openedDate (Optional, Date – MM/DD/CCYY): Open date of base share.
    • insuranceEligible (Optional, Boolean): Is individual insurance eligible.
    • excessiveWithdrawlFee (Optional, Boolean): Charge excessive withdrawal fee.
    • excessWithdrawalFeeCode (Optional, Boolean): Member eligible for excessive withdrawal fee (Y, N, E). Max 1 char.
    • dividendDisburseOption (Optional, String): Dividend/Annual disbursement option (C=Check, T=Transfer, or blank). Max 1 char.
    • whereToPayDividendAccount (Optional/Required, Number): Paid account for dividend. Max 9 chars. Required if dividendDisburseOption is T.
    • whereToPayDividendSuffix (Optional/Required, Number): Paid suffix for dividend. Max 9 chars. Required if dividendDisburseOption is T.
    • federalWithholdingCode (Optional, String): Federal withholding code (Y or N). Max 1 char.
    • stateWithholdingCode (Optional, String): State withholding code (Y or N). Max 1 char.
    • crossReferenceNumber (Optional, Number): Cross-reference number (MICR). Max 16 chars.
    • openingTeller (Required, String): Teller ID opening account/share. Max 4 chars.
    • allowPriorityTypeChange (Optional, Boolean): Suffix included in share type priority changes.
    • allowDailyNegativeFees (Optional, Boolean): Charge daily negative balance fees.
    • regulationEOptIn (Optional, Boolean): Suffix opted into Regulation E.
    • regulationENoticeDate (Optional, Date – MM/DD/CCYY).
    • reasonForREGEOPTIN (Optional, String).
    • courtesyPayAllowed (Optional, Boolean): Is courtesy pay allowed.
    • cpEnrollmentDate (Optional, Date – MM/DD/CCYY).
    • availableCourtesyPay (Optional, Number): Amount of courtesy pay available. Max 9 chars.
    • lastCorrespondenceDate (Optional, Date – MM/DD/CCYY).
    • defaultOverDraftCode (Optional, Number): Overdraft code (0-5). Max 1 char.
    • defaultOverdraftShareSuffix (Optional/Required, Number): Share suffix for overdrafting. Max 3 chars. Required if defaultOverDraftCode is 1, 3, or 4.
    • defaultOverdraftLoanSuffix (Optional/Required, Number): Loan suffix for overdrafting. Max 3 chars. Required if defaultOverDraftCode is 2, 3, or 4.
    • overdraftInformationList (Optional/Required, List): Member preferred overdraft sequence. Required if defaultOverDraftCode is 5.
    • transferOrCheckCode (Optional, String): Annual disbursement option (T=Transfer or C=Check). Max 1 char.
    • transferAccount (Optional/Required, Number): Annual Disbursement transfer account. Max 9 chars. Required if transferOrCheckCode is T.
    • transferSuffix (Optional/Required, Number): Annual Disbursement transfer suffix. Max 3 chars. Required if transferOrCheckCode is T.
    • separated (Optional, Boolean): Is the IRA share type considered SEP associated.
    • dormancyDate (Optional, Date – MM/DD/CCYY).
    • frozen (Optional, Boolean): Is suffix considered frozen.
    • chargeOffCode (Optional, String): Credit bureau charge off code. Max 2 chars.
    • chargedOffAmount (Optional, Number): Amount charged off. Max 9 chars.
    • lastUpdateDate (Optional, Date – MM/DD/CCYY).
    • userDefinedFields (Optional, Object): Credit union defined fields.

5.2. userDefinedFields Object (for Share)

These fields are credit union-defined for tracking additional information.

  • Attributes (UDF01-UDF17):
    • UDF01 to UDF08 (Optional, String): Alphanumeric, max 38 chars.
    • UDF09 to UDF11 (Optional, Number): Numeric, max 11 chars (amount/balance).
    • UDF12 to UDF14 (Optional, Number): Numeric, max 6 chars (date tracking, no slashes).
    • UDF15 (Optional, Number): Numeric, max 9 chars (alternative SSN).
    • UDF16 (Optional, Number): Numeric, max 10 chars (alternative phone number).
    • UDF17 (Optional, Number): Numeric, max 11 chars (alternative amount).

5.3. overdraftInformationList Object

Defines preferred overdrafting sequence when defaultOverDraftCode is 5.

  • Attributes:
    • sequenceNumber (Optional/Required, Number): Sequence order (starts with 1). Max 1 char.
    • overdraftAccountNumber (Optional/Required, Number): Account number associated to overdrafting sequence. Max 9 chars.
    • overdraftSuffix (Optional/Required, Number): Suffix number associated to overdrafting sequence. Max 3 chars.

5.4. jointOwners Object

Allows for single or multiple joint owner records.

  • Attributes:
    • entity (Required, Object): Joint Owner entity information (includes personal details, tax info, contact, and flags).
    • address (Required, Object): Joint Owner physical mailing address.
    • sendCollectionLetter (Optional, Boolean): Send collection letters to Joint Owner.
    • relationshipToPrimaryEntity (Optional, String): Joint Owner relationship to Primary Member. Max 4 chars.
    • emailAddress (Optional, String): Joint Owner email address. Max 128 chars.
    • suffixList (Optional, List of Numbers): Joint Owner’s account/suffix access. [] or [0] for full access, [1] for base share. Max 1 char.
    • rightOfSurviorship (Optional, Boolean): Joint Owner has survivorship rights.
    • mobileAccess (Optional, String): Allowed internet banking access (Y, N, or Null).

5.5. entity Object (for Joint Owners, Authorized Signers, Beneficiaries)

Contains comprehensive information about the individual.

  • Attributes: firstName, middleName, lastName, nameSuffix, name1, title, nickname, additionalMailingLine, taxName, taxId, taxIdFormatCode, taxIdCertified, stateTaxId, birthDate, gender, driversLicenseNumber, driversLicenseState, mothersMaidenName, securityQuestionCode, securityQuestionAnswer, deceased, deceasedDate, disabled, bankruptcy, activeMilitary, foreignCitizen, livingInForeignCountry, causedLoss, insuranceEligible, verifiedOFAC, creditUnionEmployee, creditUnionEmployeeCode, employerCode, lendingLimit, phones (Required, List), addresses (Optional, List).

5.6. address Object (Physical Mailing Address for Joint Owners, Authorized Signers, Beneficiaries)

  • Attributes: city, country, line1, line2, state, zipcode, zipcode4, badAddressDate, addressChangeDate, lastUpdateDate.

5.7. phones Object (for Joint Owners, Authorized Signers, Beneficiaries)

  • Attributes: areaCode, number, extension, countryCode, type, description.

5.8. addresses Object (Secondary Addresses for Joint Owners, Authorized Signers, Beneficiaries)

  • Attributes: city, country, line1, line2, state, zipcode, zipcode4, badAddressDate, addressChangeDate, lastUpdateDate.

5.9. authorizedSigners Object

Allows for single or multiple authorized signer records.

  • Attributes: emailAddress, firstName, middleName, lastName, title, nickname, nameSuffix, name1, additionalMailingLine, taxName, taxId, taxIdFormatCode, taxIdCertified, stateTaxId, birthDate, gender, driversLicenseNumber, driversLicenseState, mothersMaidenName, suffixList, deceased, deceasedDate, disabled, bankruptcy, activeMilitary, foreignCitizen, livingInForeignCountry, causedLoss, insuranceEligible, verifiedOFAC, creditUnionEmployee, creditUnionEmployeeCode, employerCode, address (Required, Object), info (Optional, Object), securityQuestion (Optional, Object), phones (Required, List), addresses (Optional, List).

5.10. info Object (for Authorized Signers, Beneficiaries)

Provides information about the individual’s connection to the Primary account holder and various Member flags.

  • Attributes: relationshipToPrimaryEntityAttribute, mobileAccessFlag.

5.11. securityQuestion Object (for Authorized Signers, Beneficiaries)

Provides security information for the individual.

  • Attributes: question, answer.

5.12. beneficiaries Object

Allows for a single or multiple beneficiaries to be added to the account.

  • Attributes: firstName, middleName, lastName, nameSuffix, name1, nickname, title, additionalMailingLine, taxName, taxId, taxIdFormatCode, taxIdCertified, stateTaxId, birthDate, gender, driversLicenseNumber, driversLicenseState, mothersMaidenName, deceased, deceasedDate, disabled, bankruptcy, activeMilitary, foreignCitizen, livingInForeignCountry, causedLoss, insuranceEligible, creditUnionEmployee, creditUnionEmployeeCode, employerCode, suffixList, address (Required, Object), info (Optional, Object), phones (Required, List), securityQuestion (Optional, Object), addresses (Optional, List).

6. HTTPS Status Code 500 Error Includes FLEX Validation Checks

Flex provides additional information in 500 HTTP Status Code errors for troubleshooting. These errors often indicate invalid attribute values or missing configurations in the Credit Union’s database.

  • Common Error Messages (Examples):
    • “Internal server error Share Suffix 280 already exists on Account 100799.”: Suffix value is already in use for the account.
    • “Internal server error share type is required”: Share Type value is blank or invalid.
    • “Internal server error Share Type not valid for suffix selected”: Suffix value not assigned to the Share Type.
    • “Internal server error – Suffix 70 does not exist for Account 89891”: Invalid suffix value in a Close Suffix request.
    • “Internal server error – Suffix 3 should have zero current balance before closing”: Attempting to close a suffix with a non-zero balance.
  • 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.

7. Appendix

The document includes comprehensive appendices with various code lists for reference:

  • Type Groups: Share Group Codes (e.g., A=Auxiliary, B=Base Share).
  • Relationship to Primary Member Examples: Common relationship codes (e.g., AU=Aunt, BR=Brother).
  • Charge Off Codes: Codes for account charge-offs.
  • Account Suffix Access Information: Details on suffix access for different association types (Primary Account Holder, Joint Owner, Authorized Signer, Co-Borrower, Beneficiary).