Banking

API - V 2.5

Download Swagger Spec

The Get FI Customer API is a set of basic services used to retrieve the information related to a customer of a specific financial institution (FI).

Having complete, timely, and accurate access to data about a customer is a crucial aspect of any financial institution's online systems and products.

Value

The Get FI Customer API enables customer to:

access accurate information about themselves in the system in order to manage their finances

It enables the financial institution to:

maintain and deepen the relationship with their customer by ensuring customers have all the tools and products needed to successfully manage their finances

It enables the developer to:

retrieve the customer's contact, status, and credential data from the Digital Banking system

What is Supported

The Banking Services Technical Documentation in the **API Specs** section fully describes the endpoints, header values, parameters, and responses. Below is an overview of the API capabilities:

Retrieve Digital Banking data about a particular Customer, a Digital Banking User, including:

Contact info, such as name, phone number and email address
User login Id, Credit Union Member Number of Bank Customer Number
User status on the system (Active, On Hold, Locked, etc.)
User Products (Digital Banking, Mobile, Bill Pay, etc.)

Additional Product Details

Onboarding

Enim senectus in eget bibendum donec. Mauris urna lorem et aenean. Justo auctor vel phasellus tellus tincidunt et. Ullamcorper pretium ipsum.

Ante euismod vitae morbi nisi. Commodo mauris tincidunt arcu odio hendrerit ut pulvinar lectus laoreet. Odio odio nunc iaculis sed id tempor et. Aliquam tortor quis ipsum id blandit nunc sit etiam. Sed eget libero dui quam cras.

API Access

Two unique PrimaryBid Connect API client accounts will be created and granted upon sign-off on all legal and compliance Partnership agreements.

The API client accounts include a set of credential strings (ID and secret) used to authenticate requests to the PrimaryBid Connect API on our Staging and Production environments.

Sample Response for Get FI Customer Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<ns5:FICustomer xmlns:ns2="http://schema.intuit.com/domain/banking/financialInstitution/v2">

    <ns5:id>b3326436000db5645102055a157ae715</ns5:id>

    <ns5:fiId>05526</ns5:fiId>

    <ns5:name>Sam U Simulator</ns5:name>

    <ns5:memberNumber>100000437</ns5:memberNumber>

    <ns5:hostCredential>

        <ns4:loginId>100000437</ns4:loginId>

    </ns5:hostCredential>

    <ns5:person>

        <ns4:contactInfo>

            <ns4:emailAddress>omar.kabir@candescent.com</ns4:emailAddress>

            <ns4:emailReminder>2018-07-12-07:00</ns4:emailReminder>

        </ns4:contactInfo>

    </ns5:person>

    <ns5:channelInfos>

        <ns5:channelInfo>

            <ns5:channelType>WEB</ns5:channelType>

            <ns5:credential>

                <ns4:loginId>BHAKUN</ns4:loginId>

            </ns5:credential>

            <ns5:service>0</ns5:service>

            <ns5:id>0</ns5:id>

            <ns5:failedLoginCount>0</ns5:failedLoginCount>

            <ns5:validLoginCount>1</ns5:validLoginCount>

            <ns5:userStatus>

                <ns5:limbo>false</ns5:limbo>

                <ns5:active>true</ns5:active>

                <ns5:newUser>false</ns5:newUser>

                <ns5:onHold>false</ns5:onHold>

                <ns5:reinitiated>false</ns5:reinitiated>

                <ns5:locked>false</ns5:locked>

                <ns5:acceptedDisclosure>false</ns5:acceptedDisclosure>

                <ns5:appliedForBPElectronicRegistration>false</ns5:appliedForBPElectronicRegistration>

                <ns5:needsToAcceptDisclosure>false</ns5:needsToAcceptDisclosure>

                <ns5:mustChangePassword>true</ns5:mustChangePassword>

                <ns5:invalidEmailId>false</ns5:invalidEmailId>

                <ns5:mustChangeAltUserId>false</ns5:mustChangeAltUserId>

                <ns5:needsToAcceptSecondaryDisclosure>false</ns5:needsToAcceptSecondaryDisclosure>

                <ns5:bpFrontPageFalseBpPendingPaymentsTrue>false</ns5:bpFrontPageFalseBpPendingPaymentsTrue>

                <ns5:adminApprovedIBRegistrationInMC>false</ns5:adminApprovedIBRegistrationInMC>

                <ns5:fiApprovalPending>false</ns5:fiApprovalPending>

                <ns5:reset>false</ns5:reset>

                <ns5:mfaEnrolledCookie>false</ns5:mfaEnrolledCookie>

                <ns5:mfaMandatory>false</ns5:mfaMandatory>

                <ns5:mfaOptional>false</ns5:mfaOptional>

                <ns5:inquiryOnly>false</ns5:inquiryOnly>

                <ns5:bpOptOut>false</ns5:bpOptOut>

                <ns5:smsMobileActivationConfirmed>false</ns5:smsMobileActivationConfirmed>

                <ns5:smsMobileEnrolled>false</ns5:smsMobileEnrolled>

                <ns5:issoUserEnrolled>false</ns5:issoUserEnrolled>

                <ns5:resetIssoUserEnrolled>false</ns5:resetIssoUserEnrolled>

                <ns5:entitlements>false</ns5:entitlements>

                <ns5:emailMfaEnrolled>false</ns5:emailMfaEnrolled>

                <ns5:uspEnrolled>true</ns5:uspEnrolled>

                <ns5:temporaryPassword>false</ns5:temporaryPassword>

            </ns5:userStatus>

            <ns5:lastLoginDate>2020-03-02-08:00</ns5:lastLoginDate>

            <ns5:lastLoginDateTime>2020-03-02T12:13:38-08:00</ns5:lastLoginDateTime>

        </ns5:channelInfo>

    </ns5:channelInfos>

    <ns5:billPayEnabled>false</ns5:billPayEnabled>

    <ns5:memberRegistrationDate>2013-01-24-08:00</ns5:memberRegistrationDate>

    <ns5:productUserInfo>

        <ns5:productType>IB</ns5:productType>

    </ns5:productUserInfo>

    <ns5:productAppUserInfos>

        <ns5:productAppUserInfo>

            <ns5:appCode>ANDRD</ns5:appCode>

            <ns5:lastActivityDate>2020-01-07-08:00</ns5:lastActivityDate>

        </ns5:productAppUserInfo>

        <ns5:productAppUserInfo>

            <ns5:appCode>ANDROIDWEARAPP</ns5:appCode>

            <ns5:lastActivityDate>2018-04-10-07:00</ns5:lastActivityDate>

        </ns5:productAppUserInfo>

        <ns5:productAppUserInfo>

            <ns5:appCode>APISDK</ns5:appCode>

            <ns5:lastActivityDate>2020-02-20-08:00</ns5:lastActivityDate>

        </ns5:productAppUserInfo>

        <ns5:productAppUserInfo>

            <ns5:appCode>onlineStatement</ns5:appCode>

            <ns5:OSPaperStatement>true</ns5:OSPaperStatement>

            <ns5:OSEmailReminder>false</ns5:OSEmailReminder>

            <ns5:OSDisclosure>false</ns5:OSDisclosure>

            <ns5:esignStatus>false</ns5:esignStatus>

            <ns5:OSGroup>true</ns5:OSGroup>

        </ns5:productAppUserInfo>

        <ns5:productAppUserInfo>

            <ns5:appCode>IPAD</ns5:appCode>

            <ns5:lastActivityDate>2019-11-12-08:00</ns5:lastActivityDate>

        </ns5:productAppUserInfo>

        <ns5:productAppUserInfo>

            <ns5:appCode>ANDRDTBL</ns5:appCode>

            <ns5:lastActivityDate>2019-08-28-07:00</ns5:lastActivityDate>

        </ns5:productAppUserInfo>

        <ns5:productAppUserInfo>

            <ns5:appCode>AMZNTBL</ns5:appCode>

            <ns5:lastActivityDate>2017-06-12-07:00</ns5:lastActivityDate>

        </ns5:productAppUserInfo>

        <ns5:productAppUserInfo>

            <ns5:appCode>IPHONEBANKING</ns5:appCode>

            <ns5:lastActivityDate>2020-02-06-08:00</ns5:lastActivityDate>

        </ns5:productAppUserInfo>

        <ns5:productAppUserInfo>

            <ns5:appCode>APPLEWATCHAPP</ns5:appCode>

            <ns5:lastActivityDate>2017-11-16-08:00</ns5:lastActivityDate>

        </ns5:productAppUserInfo>

        <ns5:productAppUserInfo>

            <ns5:appCode>QOL</ns5:appCode>

            <ns5:statusCode>ACTIVE</ns5:statusCode>

            <ns5:acceptedDisclosureDate>2015-07-29-07:00</ns5:acceptedDisclosureDate>

            <ns5:lastActivityDate>2018-02-06-08:00</ns5:lastActivityDate>

            <ns5:updateDateTime>2018-02-06T19:16:27-08:00</ns5:updateDateTime>

        </ns5:productAppUserInfo>

    </ns5:productAppUserInfos>

    <ns5:lastSRTDateTime>2020-03-02T08:11:00-08:00</ns5:lastSRTDateTime>

</ns5:FICustomer>