Sign in

v1

latestOpenAPI 3.0.32026-07-13347237.5 KB
Connect

Get Accounts Detail

To retrieve full account details, including transactions, the holder's name, address, email and phone number, use the /GetAccountsDetail endpoint.

post/v3/{customerId}/BankingServices/GetAccountsDetail

Path parameters

customerIdstring required

Unique GUID provided by Flinks.

Headers

x-api-keystring

Security feature that grants access to this endpoint.

Request body

RequestIdstring required

Unique identifier provided after a successful request to the /Authorize endpoint.

WithAccountIdentityboolean

Specifies if you want to include the transit number, institution number and account number.

WithKYCboolean

Specifies if you want to include customer information in the account details.

WithTransactionsboolean

Specifies if you want to include transactions in the account details.

AccountsFilterstring[]

Accounts that you are linking to this session.

DaysOfTransactions'Days90' | 'Days365'

Number of days that you want to see transaction data for.

WithDetailsAndBankingStatementsboolean

Specifies if you want to enable PDF statements.

NumberOfBankingStatementsstring

Number of PDF banking statements that are returned.

Example request

{
  "RequestId": "3fa391bc-bc52-4424-82c5-8662600df9b2",
  "WithAccountIdentity": true,
  "WithKYC": true,
  "WithTransactions": true,
  "DaysOfTransactions": "Days90",
  "WithDetailsAndBankingStatements": false,
  "NumberOfBankingStatements": "MostRecent"
}

Response

Success

HttpStatusCodeinteger
InstitutionNamestring
Loginobject

Information about the login session.

InstitutionIdinteger
Institutionstring
RequestIdstring