For more details about this API input data type please refer to this article.


Data Type
HttpStatusCodeHttpStatusCodenumberA message that indicates whether or not that request can be fulfilled (See article)
AccountsAccountsobjectContains all retrieved user accounts
Accounts\EftEligibleRatioEftEligibleRationumberRepresents the probability of Flinks to successfully gather all the details need for a ETF (See article)
Accounts\ETransferEligibleRatioETransferEligibleRationumberRepresents the probability of Flinks to successfully gather all the details need for a eTransfer (See article)
Accounts\TitleTitlestring, nullAccount title as presented by the financial institution
Accounts\AccountNumberAccountNumberstring, nullAccount number
Accounts\BalanceAvailableobjectContains the balance information for a given account
Accounts\Balance\AvailableCurrentnumber, nullBalance considering both posted and authorized transactions
Accounts\Balance\CurrentLimitnumber, nullBalance considering posted transactions
Accounts\Balance\LimitBalancenumber, nullThe maximum amount a user can have debited from the account
Accounts\CategoryCategorystring, nullAccount categories: operations, credits, products, other. (See article)
Accounts\CurrencyCurrencystring, nullAccount currency: only supported in CAD and USD
Accounts\HolderNameobjectContains the account holder's information
Accounts\Holder\NameAddressstring, nullAccount holder's name
Accounts\Holder\AddressAddressobject, nullContains the account holder's address
Accounts\Holder\Address\CivicAddressCivicAddressstring, nullAccount holder's civic address
Accounts\Holder\Address\CityCitystring, nullAccount holder's city
Accounts\Holder\Address\ProvinceProvincestring, nullAccount holder's province/state
Accounts\Holder\Address\PostalCodePostalCodestring, nullAccount holder's postal code
Accounts\Holder\Address\POBoxPOBoxstring, nullAccount holder's po box
Accounts\Holder\Address\CountryCountrystring, nullAccount holder's country
Accounts\Holder\EmailPhoneNumberstring, nullAccount holder's email
Accounts\Holder\PhoneNumberHolderstring, nullAccount holder's phone number
Accounts\IdIdstring, nullFlinks' account ID
LinksLinksobjectContains links to other complementary API endpoints
Links\relrelstring, nullComplementary API endpoint name
Links\hrefhrefstring, nullComplementary API endpoint reference article
Links\exampleexamplenullAccount holder's postal code
LoginLoginobjectContains the login data
Login\UsernameUsernamestring, nullCard user name
Login\IsScheduledRefreshIsScheduledRefreshboolean, nullIf Nightly Refreshes are enabled for that card (See article)
Login\LastRefreshLastRefreshstring, nullLast refresh date
Login\TypeTypestring, nullLogin type: personal, business
Login\IdIdstring, nullFlinks' Loginid is a unique key that represents that a connected account (See article)
InstitutionIdInstitutionIdnumber, nullFlinks' Financial Institution ID
InstitutionInstitutionstring, nullFinancial Institution name
RequestIdRequestIdstring, nullFlinks' RequestId is a unique key that can be used to make calls to other data retrieval endpoints (See article)

Related Article: