Skip to main content
POST
Get Accounts Detail
To retrieve full account details, including transactions, the holder’s name, address, email and phone number, use the /GetAccountsDetail endpoint. You must first call the /Authorize endpoint to get a valid RequestId.

Accounts Detail

The /GetAccountsDetail endpoint returns the following information about each of the accounts that are linked to the session:

Handling a 202 response

/GetAccountsDetail typically returns a 202 on the initial call. This means the data is still processing. When you receive a 202, poll /GetAccountsDetailAsync with the same RequestId every 10 seconds until you receive a 200. Set a maximum timeout of 30 minutes. /GetAccountsDetailAsync is a GET endpoint that acts as the polling companion to /GetAccountsDetail. The 200 response from /GetAccountsDetailAsync contains the same payload as a 200 from /GetAccountsDetail. For the full data retrieval flow, including prerequisites, see Retrieve Account Data.
Your server must handle 202 responses. Do not treat a 202 as an error.
As an alternative to polling, you can configure webhooks to receive the data automatically when processing completes.

Headers

x-api-key
string

Security feature that grants access to this endpoint.

Path Parameters

customerId
string
default:43387ca6-0391-4c82-857d-70d95f087ecb
required

Unique GUID provided by Flinks.

Body

application/json
RequestId
string
default:3fa391bc-bc52-4424-82c5-8662600df9b2
required

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

WithAccountIdentity
boolean
default:true

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

WithKYC
boolean
default:true

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

WithTransactions
boolean
default:true

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

AccountsFilter
string[]

Accounts that you are linking to this session.

DaysOfTransactions
enum<string>
default:Days90

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

Available options:
Days90,
Days365
WithDetailsAndBankingStatements
boolean
default:false

Specifies if you want to enable PDF statements.

NumberOfBankingStatements
string
default:MostRecent

Number of PDF banking statements that are returned.

Response

Success

HttpStatusCode
integer
Accounts
object[]
InstitutionName
string
Login
object

Information about the login session.

InstitutionId
integer
Institution
string
RequestId
string