FLEXBridge Account Management API Technical Documentation

FLEXBridge FLEXBridge FLEXBridge Account Management API Technical Documentation

This document outlines the functionalities, objects, and attributes of the FLEXBridge Account Management API, a RESTful service designed for creating and managing Member accounts within the FLEX system. This API is essential for credit unions utilizing FLEX to streamline their new account opening processes.

1. Introduction to FLEXBridge Account Management API

The FLEXBridge Account Management API facilitates the creation of new Member accounts, including the primary account holder, joint owners, authorized signers, and beneficiaries. It also handles the creation of the initial base share suffix for each account.

1.1 Key Features

  • RESTful API: Utilizes standard REST principles for communication.
  • Built-in Authentication: Each request requires HTTP authentication headers (refer to FLEX Core System documentation for details).
  • New Account Creation: Supports two primary methods for opening accounts.
  • Comprehensive Member Data: Manages various aspects of Member information, including personal details, addresses, phone numbers, emails, and financial attributes.

2. Account Opening Functions

The FLEXBridge Account Management API offers two primary HTTPS functions for opening new accounts:

  • Open Pending Account:
    • Purpose: Creates a pending Member account.
    • Process: The credit union completes the account opening process later via the FLEX system.
    • Benefit: Allows for initial record creation before finalization.
  • Open New Member Account:
    • Purpose: Creates a new Member account and a base share directly within the credit union’s database.
    • Process: Fully establishes the Member account and its primary savings suffix.

Note: Both openaccount and openpendingaccount endpoints utilize the same JSON objects and attributes for creating a Member account.

2.1 API Endpoints

  • Method: POST
  • REST URLs:
    • https://{BASE_URL}/api/accountmanagement/openaccount
    • https://{BASE_URL}/api/accountmanagement/openpendingaccount

3. Available Objects for New Account Creation

When opening a new Member account, the following JSON objects are available:

  • newAccountInfo (Required)
    • Type: newAccountInfo
    • Description: Contains basic account information and primary Member entity details.
  • baseShareInfo (Required)
    • Type: baseShareInfo
    • Description: Creates the initial base share suffix. Other account suffixes (e.g., checking, money market) are added via the Share Service API.
  • employmentList (Optional)
    • Type: List<employmentList>
    • Description: Adds single or multiple employment records for a Member.
  • jointOwners (Optional)
    • Type: List<jointOwners>
    • Description: Adds single or multiple joint owner records to a Member account.
  • authorizedSigners (Optional)
    • Type: List<authorizedSigners>
    • Description: Adds single or multiple authorized signer records to a Member account.
  • beneficiaries (Optional)
    • Type: List<beneficiaries>
    • Description: Adds single or multiple beneficiary records to a Member account.
  • notes (Optional)
    • Type: List<notes>
    • Description: Adds single or multiple notes to a Member account.

4. Object Reference Details

4.1 New Account Info Object (newAccountInfo)

This object is crucial for adding a new Member account and includes various details about the Member, physical mailing addresses, emails, base share records, and credit scores.

Attributes:

  • accountType (String, Required)
    • Description: Base account type.
    • Valid Options: B (Business), I (Individual), O (Organization), N (Non-Profit), M (Non-Citizen).
    • Max Characters: 1
  • subAccountType (String, Optional)
    • Description: Additional account type information.
    • Valid Options: C (Corporation), U (Custodial), E (Estate), L (Limited Liability Company), M (Municipality), N (Non-Profit Organization), O (Organization), P (Partnership), S (Sole Proprietorship), T (Revocable Trust), V (Irrevocable Trust).
    • Max Characters: 1
  • branchCode (String, Optional)
    • Description: Branch code for the account.
    • Max Characters: 2
  • statementCode (String, Required)
    • Description: Member’s preferred method for receiving credit union communication.
    • Valid Options: Y (Yes), N (No), B (Both Hard Copy and Email Statement), E (Email Only).
    • Max Characters: 1
  • MemberEligibility (String, Optional)
    • Description: Indicates Member’s eligibility to open an account (credit union defined).
    • Max Characters: 10
  • accountSourceCode (String, Optional)
    • Description: Indicates the source for how an individual became a credit union Member (credit union defined).
    • Max Characters: 3
  • accountDescription (String, Optional)
    • Description: Account description.
    • Max Characters: 50
  • atmDebitOptIn (Boolean, Optional)
    • Description: Is Member subject to Regulation E settings?
    • Valid Options: true, false
  • atmDebitConfirmation (Boolean, Optional)
    • Description: Did Member receive a Regulation E notice upon opting in?
    • Valid Options: true, false
  • forceNotes (String, Optional)
    • Description: Are all account notes forced for viewing by all credit union employees in FLEX’s Transaction Entry screen?
    • Valid Options: Y (Yes), N (No)
    • Max Characters: 1
  • userDefinedFields (Object, Optional)
    • Type: userDefinedFields
    • Description: Credit union defined field(s) for additional Member account information.
  • entity (Object, Required)
    • Type: entity
    • Description: Contains various information regarding the Primary account holder (name, DOB, phone numbers, address, etc.).
  • addressUsages (List<addressUsages>, Required)
    • Description: Adds single or multiple physical mailing addresses for the Primary account holder.
  • emails (List<emails>, Optional)
    • Description: Adds single or multiple email addresses for the Primary account holder.
  • creditScores (List<creditScores>, Optional)
    • Description: Adds single or multiple credit score records for the Member account.

4.2 New Account User Defined Fields (userDefinedFields)

These fields are credit union-defined and used for tracking or storing additional information. It is recommended to consult with the credit union to determine if they utilize any of these fields.

Attributes: (UDF01 to UDF17)

  • UDF01 – UDF08 (String, Optional)
    • Description: Alphanumeric characters.
    • Max Characters: 38
  • UDF09 – UDF11 (Number, Optional)
    • Description: Numeric characters (positive/negative), used as amount or balance fields.
    • Max Characters: 11
  • UDF12 – UDF14 (Number, Optional)
    • Description: Numeric characters, mainly used as additional date tracking fields (no slashes).
    • Max Characters: 6
  • UDF15 (Number, Optional)
    • Description: Numeric characters, used as an alternative SSN field (999-99-9999 format).
    • Max Characters: 9
  • UDF16 (Number, Optional)
    • Description: Numeric characters, used as an alternative phone number field (999-999-9999 format).
    • Max Characters: 10
  • UDF17 (Number, Optional)
    • Description: Numeric characters, used as an alternative amount field (99,999,999,999 format).
    • Max Characters: 11

4.3 Entity Object (entity)

The entity object is used to add Primary account holder information, including name, date of birth, phone numbers, address, and various account flag settings.

Attributes:

  • firstName (String, Required if accountType is I or M)
    • Description: First Name.
    • Max Characters: 40
  • middleName (String, Optional)
    • Description: Middle Name.
    • Max Characters: 40
  • lastName (String, Required if accountType is I or M)
    • Description: Last Name.
    • Max Characters: 40
  • nameSuffix (String, Optional)
    • Description: Suffix attached to the Member’s name.
    • Valid Options: JR., JR, JUN, SR., SR, SEN, II, III, IV, V, VI, VII, 8TH, IX.
    • Max Characters: 3
  • title(String, Optional)
    • Description: Member’s title (e.g., M.D., Ph.D.).
    • Max Characters: 42
  • nickname (String, Optional)
    • Description: Alternative name used by the Primary account holder.
    • Max Characters: 42
  • name1 (String, Required if accountType is B, O, or N)
    • Description: Business, Organization, or Non-Profit name.
    • Max Characters: 100
  • additionalMailingLine (String, Optional)
    • Description: Additional mailing line.
    • Max Characters: 40
  • taxName (String, Optional)
    • Description: Full name displayed on tax forms.
    • Max Characters: 40
  • taxId (Number, Required)
    • Description: Tax ID of an individual or business.
    • Max Characters: 9
  • taxIdFormatCode (String, Required)
    • Description: Type of Tax ID.
    • Valid Options: T (EIN), S (SSN), I (ITIN).
    • Max Characters: 1
  • taxIdCertified (Boolean, Required)
    • Description: Is Tax ID certified?
    • Valid Options: true, false
  • stateTaxId (String, Optional)
    • Description: State Tax ID.
    • Max Characters: 40
  • birthDate (Date, Required)
    • Format: MM/DD/CCYY
  • gender (String, Optional)
    • Description: Individual’s gender.
    • Valid Options: F (Female), M (Male).
    • Max Characters: 1
  • driversLicenseNumber (String, Optional)
    • Description: Drivers license number.
    • Max Characters: 25
  • driversLicenseState (String, Optional)
    • Description: Drivers license state.
    • Max Characters: 2
  • mothersMaidenName (String, Optional)
    • Description: Mother’s maiden name.
    • Max Characters: 40
  • maidenName (String, Optional)
    • Description: Individual’s maiden name.
    • Max Characters: 42
  • securityQuestionCode (String, Optional)
    • Description: Security question code.
    • Max Characters: 4
  • securityQuestionAnswer (String, Optional)
    • Description: Security question answer or Key/Security Word.
    • Max Characters: 32
  • deceased (Boolean, Optional)
    • Description: Is the Member deceased?
    • Valid Options: true, false
  • deceasedDate (Date, Optional)
    • Description: The deceased date for the Member.
    • Format: MM/DD/CCYY
  • disabled (Boolean, Optional)
    • Description: Is the Member disabled?
    • Valid Options: true, false
  • bankruptcy (Boolean, Optional)
    • Description: Is the Member in the process of bankruptcy, or considered bankrupt?
    • Valid Options: true, false
  • foreignCitizen (Boolean, Optional)
    • Description: Is the Member a foreign citizen?
    • Valid Options: true, false
  • livingInForeignCountry (Boolean, Optional)
    • Description: Is the Member living in a foreign country?
    • Valid Options: true, false
  • causedLoss (Boolean, Optional)
    • Description: Has the Member ever caused a loss to the credit union?
    • Valid Options: true, false
  • insuranceEligible (Boolean, Optional)
    • Description: Is the Member insurance eligible?
    • Valid Options: true, false
  • verifiedOFAC (String, Optional)
    • Description: Is the individual OFAC verified?
    • Valid Options: Y (Yes), N (No)
    • Max Characters: 1
  • creditUnionEmployee (Boolean, Optional)
    • Description: Is the individual a credit union employee?
    • Valid Options: true, false
  • creditUnionEmployeeCode (String, Optional)
    • Description: Credit union employee code.
    • Valid Options: Y (Yes), N (No), Null (blank)
  • employerCode (String, Optional)
    • Description: Employer code as defined by a credit union.
    • Max Characters: 4
  • lendingLimit (Number, Optional)
    • Description: The lending limit for a Member.
    • Max Characters: 9
  • phones (List<phones>, Required)
    • Description: List of phone numbers for the Primary Member. At least one is required.
  • addresses (List<addresses>, Optional)
    • Description: List of informational addresses for the Primary Member. For primary/physical mailing address, refer to the Address Usage Object.
  • activeMilitary (Boolean, Optional)
    • Description: Is the Member actively serving in military?
    • Valid Options: true, false

4.4 Phone Number Object (phones)

This object adds single or multiple phone number records to the Primary account holder.

Attributes:

  • areaCode (Number, Required)
    • Description: Area code.
    • Max Characters: 3
  • number (Number, Required)
    • Description: Phone number.
    • Max Characters: 15
  • extension (Number, Optional)
    • Description: Extension number.
    • Max Characters: 10
  • countryCode (Number, Optional)
    • Description: Country code.
    • Max Characters: 3
  • type (String, Required)
    • Description: Type of phone.
    • Valid Options: H (Home), W (Work), C (Cell), O (Other).
    • Max Characters: 1
  • description (String, Optional)
    • Description: Phone number description.
    • Max Characters: 50

4.5 Address Object (addresses)

This object adds single or multiple informational address records to the Primary account holder. It is optional. Use the addressUsages object to submit a physical mailing address.

Attributes:

  • city (String, Required)
    • Description: City.
    • Max Characters: 50
  • country (String, Required)
    • Description: Country.
    • Max Characters: 3
  • line1 (String, Required)
    • Description: Address line 1.
    • Max Characters: 50
  • line2 (String, Optional)
    • Description: Address line 2.
    • Max Characters: 50
  • state (String, Required)
    • Description: State.
    • Max Characters: 2
  • zipcode (String, Required)
    • Description: Zip code.
    • Max Characters: 10
  • zipcode4 (Number, Optional)
    • Description: Zip code + 4.
    • Max Characters: 4
  • badAddressDate (Date, Optional)
    • Description: Date when address was considered invalid.
    • Format: MM/DD/CCYY
  • addressChangeDate (Date, Optional)
    • Description: Date of last address change. For a new entry, use current system date.
    • Format: MM/DD/CCYY
  • lastUpdateDate (Date, Optional)
    • Description: Date when address was last updated. For a new entry, use current system date.
    • Format: MM/DD/CCYY

4.6 Address Usages Object (addressUsages)

This object adds single or multiple physical mailing address records to the Primary account holder. The credit union uses these addresses for statements, notifications, and other items.

Note: One usage must be present for all addresses, but usages are not repeatable if sending more than one mailing address.

Attributes:

  • city (String, Required)
    • Description: City.
    • Max Characters: 50
  • country (String, Required)
    • Description: Country.
    • Max Characters: 3
  • line1 (String, Required)
    • Description: Address line 1.
    • Max Characters: 50
  • line2 (String, Optional)
    • Description: Address line 2.
    • Max Characters: 50
  • state (String, Required)
    • Description: State.
    • Max Characters: 2
  • zipcode (String, Required)
    • Description: Zip code.
    • Max Characters: 10
  • zipcode4 (Number, Optional)
    • Description: Zip code + 4.
    • Max Characters: 4
  • badAddressDate (Date, Optional)
    • Description: Date when address was considered invalid.
    • Format: MM/DD/CCYY
  • addressChangeDate (Date, Optional)
    • Description: Date of last address change. For a new entry, use current system date.
    • Format: MM/DD/CCYY
  • lastUpdateDate (Date, Optional)
    • Description: Date when address was last updated. For a new entry, use current system date.
    • Format: MM/DD/CCYY
  • usages (List<String>, Required)
    • Description: Indicates use for the address. Each usage can be used once per address. An address can have more than one usage. Sending an empty list [] checks all address usages for a single address.
    • Valid Options for multiple addresses: R (Receipt), S (Statement), T (Tax), CS (Credit Card Statement), CI (Card Issue), P (Physical Address).
    • Max Characters: 2

4.7 Emails Object (emails)

This object adds single or multiple email records to the Primary account holder. It is optional unless the statementCode value equals B or E.

Attributes:

  • sequenceNumber (Number, Optional, Required if multiple emails are added)
    • Description: Email ID sequence number (starts with 1 and increments).
  • address (String, Required)
    • Description: Email address.
  • statements (Boolean, Required)
    • Description: Use email address for statements?
    • Valid Options: true, false
  • receipts (Boolean, Required)
    • Description: Use email address for receipts?
    • Valid Options: true, false
  • notices (Boolean, Required)
    • Description: Use email address for NSF notices?
    • Valid Options: true, false
  • creditCardStatements (Boolean, Required)
    • Description: Use email address for credit card statements (in-house only)?
    • Valid Options: true, false
  • mailings (Boolean, Required)
    • Description: Use email address for mailers?
    • Valid Options: true, false
  • alerts (Boolean, Required)
    • Description: Use email address for eAlerts?
    • Valid Options: true, false
  • helocStatements (Boolean, Required)
    • Description: Use email address for HELOC statements?
    • Valid Options: true, false
  • newsletters (Boolean, Required)
    • Description: Use email address for newsletters?
    • Valid Options: true, false
  • badAddress (Boolean, Required)
    • Description: Is the email address invalid?
    • Valid Options: true, false

4.8 Credit Scores Object (creditScores)

This object adds single or multiple credit report records to the Primary account holder.

Attributes:

  • processorType (String, Optional/Required if creditScores object is added)
    • Description: Credit bureau processor code.
    • Valid Options: EQ (Equifax), EX (Experian), TU (Transunion), HS (Hart software), BC (CBC).
    • Max Characters: 2
  • scoreType (String, Optional/Required if creditScores object is added)
    • Description: Credit union defined credit bureau report code.
    • Max Characters: 2
  • scoreDate (Date, Optional/Required if creditScores object is added)
    • Description: Date credit report inquiry occurred.
    • Format: MM/DD/CCYY
  • score (Number, Optional/Required if creditScores object is added)
    • Description: Credit score.
    • Max Characters: 5
  • grade (String, Optional/Required if creditScores object is added)
    • Description: Credit union defined grade value.
    • Max Characters: 3

4.9 Base Share Information Object (baseShareInfo)

This object adds a base share suffix upon opening a new Member account and is required for all requests. The base share is the primary savings for a new account. Other suffixes are added using the Share Service API.

Attributes:

  • shareType (String, Required)
    • Description: Credit union defined share type value.
    • Max Characters: 2
  • description (String, Optional)
    • Description: Description of the base share. If blank, system adds credit union default.
    • Max Characters: 2
  • openedDate (Date, Optional)
    • Description: Open date of base share. For new entry, use current system date.
    • Format: MM/DD/CCYY
  • insuranceEligible (Boolean, Optional)
    • Description: Is individual insurance eligible?
    • Valid Options: true, false
  • excessiveWithdrawlFee (Boolean, Optional)
    • Description: Charge excessive withdrawal fee.
    • Valid Options: true, false
    • Note: FLEX is aware of the attribute misspelling. Please use as shown; spelling will be corrected in a future version.
  • excessWithdrawlFeeCode (Boolean, Optional)
    • Description: Indicates if a Member is eligible for an excessive withdrawal fee.
    • Valid Options: Y (Yes), N (No), E (Exempt to Excessive Withdrawal Fees, but allows a Member to be eligible for the withdrawal).
    • Max Characters: 1
  • dividendDisburseOption (String, Optional)
    • Description: Dividend/Annual disbursement option. If set to T, whereToPayDividendAccount and whereToPayDividendSuffix are required.
    • Valid Options: C (Check), T (Transfer), or leave blank for no distribution.
    • Max Characters: 1
  • whereToPayDividendAccount (Number, Optional/Required if dividendDisburseOption is T)
    • Description: Indicates the paid account for dividend or annual disbursement.
    • Max Characters: 9
  • whereToPayDividendSuffix (Number, Optional/Required if dividendDisburseOption is T)
    • Description: Indicates the paid suffix number for dividend or annual disbursement.
    • Max Characters: 9
  • federalWithholdingCode (String, Optional)
    • Description: Federal withholding code.
    • Valid Options: Y (Yes), N (No).
    • Max Characters: 1
  • crossReferenceNumber (Number, Optional)
    • Description: The cross-reference number (MICR) indicating the account during Draft or ACH processing. Will not populate for FLEX Share Type Groups P, T, N, and I.
    • Max Characters: 16
  • openingTeller (String, Required)
    • Description: Teller ID opening account/share.
    • Max Characters: 4
  • allowPriorityTypeChange (Boolean, Optional)
    • Description: Is suffix included in share type priority changes?
    • Valid Options: true, false
  • allowDailyNegativeFees (Boolean, Optional)
    • Description: Charge daily negative balance fees?
    • Valid Options: true, false
  • regulationEOptIn (Boolean, Optional)
    • Description: Has the suffix opted into Regulation E?
    • Valid Options: true, false
  • regulationENoticeDate (Date, Optional)
    • Description: Date notice was sent for suffix regarding Reg E.
    • Format: MM/DD/CCYY
  • reasonForREGEOPTIN (String, Optional)
    • Description: Reason for Reg E Opt-in.
  • courtesyPayAllowed (Boolean, Optional)
    • Description: Is courtesy pay allowed?
    • Valid Options: true, false
    • Max Characters: 1
  • cpEnrollmentDate (Date, Optional)
    • Description: Date of courtesy pay enrollment.
    • Format: MM/DD/CCYY
  • availableCourtesyPay (Number, Optional)
    • Description: Amount of courtesy pay available.
    • Max Characters: 9
  • lastCorrespondenceDate (Date, Optional)
    • Description: Date of last correspondence.
    • Format: MM/DD/CCYY
  • defaultOverDraftCode (Number, Optional)
    • Description: Overdraft code. Refer to Overdraft Information section for details.
    • Valid Options: 0 (no overdrafting), 1 (transfer from share account only), 2 (transfer from loan account only), 3 (transfer from shares, then loan), 4 (transfer from loan, then shares), 5 (use transfer/overdraft file).
    • Max Characters: 1
  • defaultOverdraftShareSuffix (Number, Optional/Required when defaultOverDraftCode is 1, 3 or 4)
    • Description: Share suffix used when overdrafting occurs.
    • Max Characters: 3
  • defaultOverdraftLoanSuffix (Number, Optional/Required when defaultOverDraftCode is 2, 3 or 4)
    • Description: Loan suffix used when overdrafting occurs.
    • Max Characters: 3
  • overdraftInformationList (List<overdraftInformationList>, Optional/Required when defaultOverDraftCode is 5)
    • Description: Indicates Member preferred overdraft sequence.
  • transferOrCheckCode (String, Optional)
    • Description: Annual disbursement option. If value equals T, transferAccount and transferSuffix are required.
    • Valid Options: T (Transfer), C (Check).
    • Max Characters: 1
  • transferAccount (Number, Optional/Required when transferOrCheckCode is T)
    • Description: Annual Disbursement transfer account.
    • Max Characters: 9
  • transferSuffix (Number, Optional/Required when transferOrCheckCode is T)
    • Description: Annual Disbursement transfer suffix.
    • Max Characters: 3
  • dormancyDate (Date, Optional)
    • Description: Date a suffix was marked as dormant.
    • Format: MM/DD/CCYY
  • frozen (Boolean, Optional)
    • Description: Is suffix considered frozen?
    • Valid Options: true, false
  • chargeOffCode (String, Optional)
    • Description: Credit bureau charge off code.
    • Max Characters: 2
  • chargedOffAmount (Number, Optional)
    • Description: Amount charged off.
    • Max Characters: 9
  • lastUpdateDate (Date, Optional)
    • Description: Date of last transaction or maintenance change to suffix.
    • Format: MM/DD/CCYY
  • userDefinedFields (Object, Optional)
    • Type: userDefinedFields
    • Description: Credit union defined field(s) for additional Member account information.

4.10 Base Share User Defined Fields (userDefinedFields)

These fields are credit union-defined and used for tracking or storing information related to the base share. It is recommended to consult with the credit union to determine if they utilize any of these fields.

Attributes: (UDF01 to UDF17 – same as New Account User Defined Fields)

4.11 Employment List Information Object (employmentList)

This object adds single or multiple employment records to the Primary account holder. It is optional.

Attributes:

  • startDate (Date, Optional)
    • Description: Start date of employment.
    • Format: MM/DD/CCYY
  • endDate (Date, Optional)
    • Description: End date of employment. If not applicable, leave attribute out of JSON data.
    • Format: MM/DD/CCYY
  • titlePosition (String, Optional)
    • Description: Job title or position.
    • Max Characters: 32
  • fullOrPartTime (String, Optional)
    • Description: Indicates if employment is considered full or part-time.
    • Valid Options: F (Full time), P (Part-time), O (Other).
    • Max Characters: 1
  • basePay (Number, Optional)
    • Description: Base pay amount.
    • Max Characters: 14
  • payFrequency (String, Optional)
    • Description: Pay amount frequency.
    • Valid Options: W (Weekly), B (Bi-weekly), F (Semi-monthly), M (Monthly), Q (Quarterly), S (Semi-annually), A (Annually).
    • Max Characters: 1
  • commentLine1 – commentLine4 (String, Optional)
    • Description: Employment note lines.
    • Max Characters: 78
  • employer (Object, Required)
    • Type: employer
    • Description: Holds employer information.

4.12 Employer Information Object (employer)

This object holds employer information.

Attributes:

  • employerName (String, Optional/Required when object is added to JSON export)
    • Description: Employer name.
    • Max Characters: 32
  • contactName (String, Optional)
    • Description: Employer contact.
    • Max Characters: 32
  • contactPhone (Number, Optional)
    • Description: Employer phone number.
    • Max Characters: 11
  • contactExtension (String, Optional)
    • Description: Employer phone number extension.
    • Max Characters: 5
  • addressLine1 (String, Optional)
    • Description: Employer address line 1.
    • Max Characters: 32
  • addressLine2 (String, Optional)
    • Description: Employer address line 2.
    • Max Characters: 32
  • city (String, Optional)
    • Description: Employer city.
    • Max Characters: 32
  • state (String, Optional)
    • Description: Employer state.
    • Max Characters: 2
  • zipCode (Number, Optional)
    • Description: Employer zip code.
    • Max Characters: 5
  • zipCodeExtension (Number, Optional)
    • Description: Employer zip code + 4.
    • Max Characters: 4

4.13 Overdraft Information

This section expands on the defaultOverDraftCode, defaultOverdraftShareSuffix, and defaultOverdraftLoanSuffix attributes under the baseShareInfo object. If a Member does not opt into overdrafting, these attributes can be excluded or set to zero.

Overdraft Code Values (for attribute defaultOverDraftCode):

  • 0 (No Overdraft): Send attribute value of 0 or leave attribute out.
  • 1 (Share Only): Send attribute value 1. defaultOverdraftShareSuffix is required.
  • 2 (Loan Only): Send attribute value 2. defaultOverdraftLoanSuffix is required.
  • 3 (Share and Loan, but Share First): Send attribute value 3. defaultOverdraftShareSuffix and defaultOverdraftLoanSuffix are required.
  • 4 (Share and Loan, but Loan First): Send attribute value 4. defaultOverdraftShareSuffix and defaultOverdraftLoanSuffix are required.
  • 5 (Overdraft File): Send attribute value of 5. The overdraftInformationList is required.

4.14 Overdraft File Object (overdraftInformationList)

This object allows a Member to define a preferred sequence of overdrafting using any account or suffix. It is required when the defaultOverDraftCode attribute equals 5.

Attributes:

  • sequenceNumber (Number, Optional/Required when defaultOverDraftCode is 5)
    • Description: Indicates the sequence order for overdrafting (always starts with 1).
    • Max Characters: 1
  • overdraftAccountNumber (Number, Optional/Required when defaultOverDraftCode is 5)
    • Description: Account number associated to overdrafting sequence.
    • Max Characters: 9
  • overdraftSuffix (Number, Optional/Required when defaultOverDraftCode is 5)
    • Description: Suffix number associated to overdrafting sequence.
    • Max Characters: 3

4.15 Joint Owners Object (jointOwners)

This object allows for single or multiple joint owner records to be linked to a new account.

Attributes:

  • entity (Object, Required)
    • Type: entity
    • Description: Joint Owner entity information.
  • address (Object, Required)
    • Type: address
    • Description: Joint Owner physical mailing address.
  • sendCollectionLetter (Boolean, Optional)
    • Description: Send collection letters to Joint Owner?
    • Valid Options: true, false
  • relationshipToPrimaryEntity (String, Optional)
    • Description: Joint Owner relationship to Primary Member.
    • Max Characters: 4
  • emailAddress (String, Optional)
    • Description: Joint Owner email address.
    • Max Characters: 128
  • suffixList (List<Number>, Optional)
    • Description: Indicates Joint Owner’s account/suffix access. [] or [0] grants full account access. [1] grants access only to base share suffix.
    • Max Characters: 1
  • rightOfSurviorship (Boolean, Optional)
    • Description: Does the Joint Owner have the rights of survivorship?
    • Valid Options: true, false
    • Note: FLEX is aware of the attribute misspelling. Please use as shown; spelling will be corrected in a future version.
  • mobileAccess (String, Optional)
    • Description: Is the Joint Owner allowed internet banking access?
    • Valid Options: Y (Yes), N (No), Null (blank).

4.16 Joint Owner Address Object (address)

This object indicates the physical mailing address for a Joint Owner and is required when a Joint Owner is created.

Attributes: (Same as Address object attributes)

4.17 Joint Owner Entity Object (entity)

This object adds various Joint Owner information (e.g., phone numbers, additional addresses, and other Member flags).

Attributes: (Similar to Primary Member entity object, with some differences in required fields)

  • firstName (String, Required)
  • middleName (String, Optional)
  • lastName (String, Required)
  • nameSuffix (String, Optional)
  • name1 (String, Optional)
  • additionalMailingLine (String, Optional)
  • taxName (String, Optional)
  • taxId (Number, Required)
  • taxIdFormatCode (String, Required)
  • taxIdCertified (Boolean, Required)
  • stateTaxId (String, Optional)
  • birthDate (Date, Required)
  • gender (String, Optional)
  • driversLicenseNumber (String, Optional)
  • driversLicenseState (String, Optional)
  • mothersMaidenName (String, Optional)
  • securityQuestionCode (String, Optional)
  • securityQuestionAnswer (String, Optional)
  • deceased (Boolean, Optional)
  • deceasedDate (Date, Optional)
  • disabled (Boolean, Optional)
  • bankruptcy (Boolean, Optional)
  • activeMilitary (Boolean, Optional)
  • foreignCitizen (Boolean, Optional)
  • livingInForeignCountry (Boolean, Optional)
  • causedLoss (Boolean, Optional)
  • insuranceEligible (Boolean, Optional)
  • verifiedOFAC (String, Optional)
  • creditUnionEmployee (Boolean, Optional)
  • creditUnionEmployeeCode (String, Optional)
  • employerCode (String, Optional)
  • lendingLimit (Number, Optional)
  • phones (List<phones>, Required)
  • addresses (List<addresses>, Optional)

4.18 Joint Owner Entity Phone Object (phones)

This object allows for single or multiple Joint Owner phone numbers and is required under the jointOwners object.

Attributes: (Same as Phone Number object attributes)

4.19 Joint Owner Entity Address Object (addresses)

This object allows for a single or multiple secondary addresses for the Joint Owner. This object type is optional.

Attributes: (Same as Address object attributes)

4.20 Authorized Signer Information Object (authorizedSigners)

This object allows for single or multiple authorized signer records to be created for a Member account.

Attributes:

  • emailAddress (String, Optional)
    • Description: Authorized Signer email address.
    • Max Characters: 128
  • firstName (String, Required)
  • middleName (String, Optional)
  • lastName (String, Required)
  • title (String, Optional)
  • nickname (String, Optional)
  • nameSuffix (String, Optional)
  • name1 (String, Optional)
  • additionalMailingLine (String, Optional)
  • taxName (String, Optional)
  • taxId (Number, Required)
  • taxIdFormatCode (String, Required)
  • taxIdCertified (Boolean, Required)
  • stateTaxId (String, Optional)
  • birthDate (Date, Required)
  • gender (String, Optional)
  • driversLicenseNumber (String, Optional)
  • driversLicenseState (String, Optional)
  • mothersMaidenName (String, Optional)
  • deceased (String, Optional)
  • deceasedDate (Date, Optional)
  • disabled (Boolean, Optional)
  • bankruptcy (Boolean, Optional)
  • activeMilitary (Boolean, Optional)
  • foreignCitizen (Boolean, Optional)
  • livingInForeignCountry (Boolean, Optional)
  • causedLoss (Boolean, Optional)
  • insuranceEligible (Boolean, Optional)
  • verifiedOFAC (String, Optional)
  • creditUnionEmployee (Boolean, Optional)
  • creditUnionEmployeeCode (String, Optional)
  • employerCode (String, Optional)
  • address (Object, Required)
    • Type: address
    • Description: Authorized Signer physical mailing address.
  • info (Object, Optional)
    • Type: info
    • Description: Indicates Authorized Signer relationship to Primary Member and other member flags.
  • securityQuestion (Object, Optional)
    • Type: securityQuestion
    • Description: Authorized Signer security information.
  • phones (List<phones>, Required)
    • Description: Authorized Signer phone number.
  • addresses (List<addresses>, Optional)
    • Description: Authorized Signer secondary address information.

4.21 Authorized Signer Address Object (address)

This object indicates the physical mailing address for an Authorized Signer and is required when an Authorized Signer is added.

Attributes: (Same as Address object attributes)

4.22 Authorized Signer Phone Number Object (phones)

This object allows for single or multiple authorized signer phone numbers. This object is required.

Attributes: (Same as Phone Number object attributes)

4.23 Authorized Signer Secondary Address Object (addresses)

This object allows for a single or multiple secondary addresses for the Authorized Signer. This object is optional.

Attributes: (Same as Address object attributes)

4.24 Authorized Signer Security Question Object (securityQuestion)

This object provides the security information for the Authorized Signer. The object is optional.

Attributes:

  • question (String, Optional)
    • Description: Security question code.
    • Max Characters: 4
  • answer (String, Optional)
    • Description: Security question answer or Key/Security Word.
    • Max Characters: 32

4.25 Authorized Signer Information Object (info)

This object provides information about the Authorized Signer’s connection to the Primary account holder and various Member flags. This object is optional.

Attributes:

  • relationshipToPrimaryEntityAttribute (String, Optional)
    • Description: Authorized Signer relationship to Primary account holder. Refer to “Relationship to Primary Member” under the Appendix.
    • Max Characters: 4
  • mobileAccessFlag (String, Optional)
    • Description: Is the Authorized Signer allowed internet banking access?
    • Valid Options: Y (Yes), N (No), Null (blank).

4.26 Beneficiary Information Object (beneficiaries)

This object allows for a single or multiple Beneficiaries to be added to the account. This object is optional.

Attributes:

  • firstName (String, Required)
  • middleName (String, Optional)
  • lastName (String, Required)
  • nameSuffix (String, Optional)
  • name1 (String, Optional)
  • nickname (String, Optional)
  • title (String, Optional)
  • additionalMailingLine (String, Optional)
  • taxName (String, Optional)
  • taxId (Number, Required)
  • taxIdFormatCode (String, Required)
  • taxIdCertified (Boolean, Required)
  • stateTaxId (String, Optional)
  • birthDate (Date, Required)
  • gender (String, Optional)
  • driversLicenseNumber (String, Optional)
  • driversLicenseState (String, Optional)
  • mothersMaidenName (String, Optional)
  • deceased (String, Optional)
  • deceasedDate (Date, Optional)
  • disabled (Boolean, Optional)
  • bankruptcy (Boolean, Optional)
  • activeMilitary (Boolean, Optional)
  • foreignCitizen (Boolean, Optional)
  • livingInForeignCountry (Boolean, Optional)
  • causedLoss (Boolean, Optional)
  • insuranceEligible (Boolean, Optional)
  • creditUnionEmployee (Boolean, Optional)
  • creditUnionEmployeeCode (String, Optional)
  • employerCode (String, Optional)
  • suffixList (Number, Optional)
    • Description: Indicates Beneficiary account suffix access. 0 for all suffixes, 1 for base share suffix only for new accounts.
  • address (Object, Required)
    • Type: address
    • Description: Beneficiary physical mailing address.
  • phones (List<phones>, Required)
    • Description: Beneficiary phone number information.
  • addresses (List<addresses>, Optional)
    • Description: Beneficiary secondary address information.
  • info (Object, Optional)
    • Type: info
    • Description: Indicates Beneficiary relationship to Primary Member, mobile access, and death payout percentage.
  • securityQuestion (Object, Optional)
    • Type: securityQuestion
    • Description: Indicates Beneficiary security information.

4.27 Beneficiary Address Object (address)

This object indicates the physical mailing address for a Beneficiary and is required when a Beneficiary is created.

Attributes: (Same as Address object attributes)

4.28 Beneficiary Phone Number Object (phones)

This object allows for single or multiple Beneficiary phone numbers. This object is required.

Attributes: (Same as Phone Number object attributes)

4.29 Beneficiary Secondary Address Object (addresses)

This object allows for a single or multiple secondary addresses for the Beneficiary. This object is optional.

Attributes: (Same as Address object attributes)

4.30 Beneficiary Security Question Object (securityQuestion)

This object provides the security information for the Beneficiary.

Attributes: (Same as Authorized Signer Security Question object attributes)

4.31 Beneficiary Information Object (info)

This object provides information about the Beneficiary’s relationship to the Primary account holder, mobile access, and death payout percentage.

Attributes:

  • relationshipToPrimaryEntityAttribute (String, Optional)
    • Description: Beneficiary relationship to Primary account holder.
    • Max Characters: 4
  • deathPayoutPercentage (Number, Optional)
    • Description: The percentage amount paid out upon the death of the Primary account holder.
    • Max Characters: 5
  • mobileAccessFlag (String, Optional)
    • Description: Is the Beneficiary allowed internet banking access?
    • Valid Options: Y (Yes), N (No), Null (blank).

4.32 Account Notes Object (notes)

The notes object allows for single or multiple notes to be added to the account and are tied to the Primary account holder. This object is optional. Attributes marked as Required are only needed if the object is included in JSON data.

Attributes:

  • subject (String, Required)
    • Description: Creates note subject heading.
    • Max Characters: 250
  • text (String, Required)
    • Description: Creates the note text.
    • Max Characters: 4500
  • noteCategory (Number, Required)
    • Description: FLEX defined note categories.
    • Valid Options: 1 (Standard), 2 (Collections), 3 (Phone), 4 (DealerTrack), 5 (Loan Application), 6 (Receipt Notes).
    • Max Characters: 1
  • notePriority (Number, Required)
    • Description: A FLEX defined priority setting for Member notes.
    • Valid Options: 1 (Informational), 2 (Warning), 3 (Critical).
    • Max Characters: 1
  • noteReason (Number, Optional)
    • Description: A credit union defined numeric value that displays as a description indicating reason for note.
    • Max Characters: 10
  • creationDate (Date, Optional)
    • Description: Creation date of when a note was added. FLEX advises sending current system date.
    • Format: MM/DD/CCYY
  • teller (String, Optional)
    • Description: Teller ID associated with creating the note.
    • Max Characters: 10
  • expirationDate (Date, Optional)
    Description: Expiration date of when a note is removed.

    • Format: MM/DD/CCYY
  • lastModifiedDate (Date, Optional)
    • Description: Attribute can be excluded from JSON data because it is populated by FLEX with current system date when note is created.
    • Format: MM/DD/CCYY

5. New Account Response

A successful new account creation will return an accountNumber.

Example of a Successful New Account Response:

{
  “accountNumber”: 30161
}

6. HTTPS Status Code 500 Error Includes FLEX Validation Checks

FLEX provides additional information in 500 HTTP Status Code errors to assist with troubleshooting. These errors often indicate invalid attribute values or missing configurations within the credit union database.

Common Error Messages:

  • {“message”: “Internal server error – Suffix 001 is not defined.”}
    • Reason: The base Share Type value is not configured to use suffix value 1 (or 001).
  • {“message”: “Internal server error – Address usage does not exist”}
    • Reason: An invalid address usage value was sent.
  • {“message”: “Internal server error – Base share type is required”}
    • Reason: The base Share Type value is blank or invalid.

Recommendation: Provide the error message to the credit union for troubleshooting, as they are typically familiar with these messages and how to correct the data.

7. Appendix

7.1 Pre-Decision Information

This section outlines potential Member Pre-Decision information that a credit union can use in the decisioning process. This information is available from response objects returned from various Member search queries in the FLEX Account Inquiry API Service Document.

Fields from FLEX Address Maintenance (returned with Tax ID or account query responses in the accounts object):

  • Account Frozen Flag (frozenFlag)
  • Is Member on Do Not Allow List (doNotAllow)

Fields from Account Overview object (accountOverview) (returned from a detailed account search):

  • Frozen Account (frozenAccount)
  • Risk Level (riskLevel)

Fields from Primary, Joint Owner, Authorized Signer, Co-Borrower entity objects (from FLEX Member Maintenance options):

  • Bankrupt (bankruptcy)
  • Caused Loss (causedLoss)
  • Credit Union Employee (creditUnionEmployee)
  • Active Military (activeMilitary)

Fields from Share information object (shares) (from FLEX Share Maintenance):

  • Charge off code (chargeOffCode)
  • Charged Off Amount (chargedOffAmount)
  • Frozen (frozen)

Fields from Loan information object (loans) (from FLEX Loan Maintenance):

  • Suffix Included in Bankruptcy (suffixIncludedInBankruptcy)
  • Times 30 Days Delinquent (times30DaysDelinquent)
  • Times 60 Days Delinquent (times60DaysDelinquent)
  • Times 90 Days Delinquent (times90DaysDelinquent)
  • Times 120 Days Delinquent (times120DaysDelinquent)
  • Delinquent Amount (delinquentAmount)
  • Delinquent Loan (delinquentLoan)
  • Delinquent Days (delinquentDays)
  • Charge Off Code (chargeOffCode)
  • Charged Off Amount (chargedOffAmount)
  • Number of Late Charges (numberOfLateCharges)
  • Loan Credit Grade (creditGrade)
  • Loan Credit Score (creditScore)

7.2 Type Groups

Base Share Group Codes (FLEX assigned):

  • A = Auxiliary
  • B = Base Share
  • D = Draft
  • E = Escrow
  • I = IRA
  • M = Money Market
  • N = Roth IRA
  • P = Educational IRA
  • T = Roth Conversion IRA
  • G = Health Savings

7.3 Relationship to Primary Member Examples

  • AU = Aunt
  • BO = Beneficial Owner
  • BR = Brother
  • BU = Business Owner
  • CO = Cousin
  • DA = Daughter
  • FA = Father
  • MO = Mother
  • GRF = Grandfather
  • GRM = Grandmother
  • HU = Husband
  • WI = Wife
  • NIEC = Niece
  • NEPH = Nephew
  • OR = Other Relative
  • SI = Sister
  • SO = Son
  • UN = Uncle

7.4 Charge Off Codes

  • R – Resolved
  • 68 – Account PIF for less than the full balance
  • 89 – Deed received in lieu of foreclosure
  • 93 – Account Assigned to internal/external collections
  • 94 – Foreclosure/sold collateral to settle mortgage
  • 95 – Voluntary surrender
  • 96 – Repossessed by credit grantor may have a balance due
  • 97 – Unpaid balance reported as a loss by the creditor

7.5 Account Suffix Access Information

The suffix attribute (under the accounts object) designates account suffix access.

  • Primary Account Holder: suffix value is 0 (full account suffix access).
  • Joint Owners, Authorized Signers, Beneficiaries:
    • suffix value is 0 for access to all account share suffixes.
    • Otherwise, suffix reflects the accessible account share suffix value (e.g., 1 or 115).
    • When access is limited, the account service response object will contain multiple records indicating accessible suffix values.
  • Co-Borrowers:
    • suffix value equals the loan suffix they were assigned.
    • Multiple response records exist if assigned to other loans.
    • Typically, Co-Borrowers do not have access to share suffixes.

Recommendation: Consult with the credit union to understand how access should be granted for each Association Type on an account, as it is credit union defined and varies per institution.

Association Types and Commonly Seen Suffix Access:

  • Primary Account Holder: Total account suffix access (including all certificates of deposit, IRAs, share, and loan suffixes).
  • Joint Owner: Usually has access to all account shares suffixes, excluding IRAs.
  • Authorized Signer: Access based on what is defined by the credit union and type of account (Individual or Business).
  • Co-Borrower: Usually only has access to the account loan suffix it is assigned to.
  • Beneficiary: Usually only has account access to the account after the death of the Primary account holder.

Note: FLEX advises using the suffixList attribute, which is provided in the response from an Account Detail search (see suffixList under the Account Overview object). Beneficiary information is only found with Tax ID searches because a Beneficiary will usually have the least amount of account access (credit union industry standard).