Input:
For more details about this API input data type please refer to this article.
Output:
Path | Variable | Data Type | Description |
| HttpStatusCode | HttpStatusCode | number | A message that indicates whether or not that request can be fulfilled (See article) |
| Accounts | Accounts | object | Contains all retrieved user accounts |
| Accounts\EftEligibleRatio | EftEligibleRatio | number | Represents the probability of Flinks to successfully gather all the details need for a ETF (See article) |
| Accounts\ETransferEligibleRatio | ETransferEligibleRatio | number | Represents the probability of Flinks to successfully gather all the details need for a eTransfer (See article) |
| Accounts\Title | Title | string, null | Account title as presented by the financial institution |
| Accounts\AccountNumber | AccountNumber | string, null | Account number |
| Accounts\Balance | Available | object | Contains the balance information for a given account |
| Accounts\Balance\Available | Current | number, null | Balance considering both posted and authorized transactions |
| Accounts\Balance\Current | Limit | number, null | Balance considering posted transactions |
| Accounts\Balance\Limit | Balance | number, null | The maximum amount a user can have debited from the account |
| Accounts\Category | Category | string, null | Account categories: operations, credits, products, other. (See article) |
| Accounts\Type | Type | string, null | Account types: checking, savings, credit card, TFSA, RRSP, unkown. (See article) |
| Accounts\Currency | Currency | string, null | Account currency: only supported in CAD and USD |
| Accounts\Holder | Name | object | Contains the account holder's information |
| Accounts\Holder\Name | Address | string, null | Account holder's name |
| Accounts\Holder\Address | Address | object, null | Contains the account holder's address |
| Accounts\Holder\Address\CivicAddress | CivicAddress | string, null | Account holder's civic address |
| Accounts\Holder\Address\City | City | string, null | Account holder's city |
| Accounts\Holder\Address\Province | Province | string, null | Account holder's province/state |
| Accounts\Holder\Address\PostalCode | PostalCode | string, null | Account holder's postal code |
| Accounts\Holder\Address\POBox | POBox | string, null | Account holder's po box |
| Accounts\Holder\Address\Country | Country | string, null | Account holder's country |
| Accounts\Holder\Email | PhoneNumber | string, null | Account holder's email |
| Accounts\Holder\PhoneNumber | Holder | string, null | Account holder's phone number |
| Accounts\AccountType | AccountType | string, null | Account type: personal, business |
| Accounts\Id | Id | string, null | Flinks' account ID |
| Links | Links | object | Contains links to other complementary API endpoints |
| Links\rel | rel | string, null | Complementary API endpoint name |
| Links\href | href | string, null | Complementary API endpoint reference article |
| Links\example | example | null | Account holder's postal code |
| Login | Login | object | Contains the login data |
| Login\Username | Username | string, null | Card user name |
| Login\IsScheduledRefresh | IsScheduledRefresh | boolean, null | If Nightly Refreshes are enabled for that card (See article) |
| Login\LastRefresh | LastRefresh | string, null | Last refresh date |
| Login\Type | Type | string, null | Login type: personal, business |
| Login\Id | Id | string, null | Flinks' Loginid is a unique key that represents that a connected account (See article) |
| InstitutionId | InstitutionId | number, null | Flinks' Financial Institution ID |
| Institution | Institution | string, null | Financial Institution name |
| RequestId | RequestId | string, null | Flinks' RequestId is a unique key that can be used to make calls to other data retrieval endpoints (See article) |
Related Article:
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article