Import a bank link
post/users/{fp_id}/bank_links/import
Preview
External ID
Locked
Request
Path parameters
fp_id·string
Body
accounts·array of objects
List of accounts to import
account_id·string
Your internal ID for this account. Must be unique within the imported account batch.
account_type·anyOf
The bank account type.
balances·object
The balances of the account
name·string
The name of the account
external_id·optional string
An optional external id for the link
institution_id·string
The institution id of the link
provider·optional string
The provider that you are importing from
Allowed values:
plaidtransactions·array of objects
List of transactions to import
account_id·string
The internal account ID associated with this transaction
amount·string
The amount of the transaction
date·string
The date of the transaction in ISO-8601 format
description·optional string
The description of the transaction
transaction_id·optional string
The transaction ID
transaction_type·optional string
The type of the transaction
Response
available_products·array of strings
The available productions for the link
Allowed values:
accountsaccount_numberstransactionsinvestmentsidentityenrichmentcreated_at·string
The date and time the link was created
error_code·optional string
The error code
Allowed values:
system_errorprovider_errorinstitution_erroruser_errorauth_expiredno_accountsuser_setup_requiredinvalid_credentialsuser_oauth_denieduser_input_incorrectincompleteexternal_id·optional string
The external id of the link
fp_id·string
The footprint entity owning the link
id·string
The link ID
institution_id·optional string
The institution ID
institution_logo·optional string
The institution logo
institution_name·optional string
The account name
products·object
The products added to the link and their statuses
account_numbers·optional object
accounts·optional object
enrichment·optional object
identity·optional object
investments·optional object
transactions·optional object
provider·optional string
The underlying data provider used to establish the link
state·string
The link state
Allowed values:
connectingconnecteddeletederrortags·optional array of strings
Tags for the link
POSTÂ /users/{fp_id}/bank_links/import
Response example
{
"available_products": [
"accounts",
"account_numbers"
],
"created_at": "2021-01-01T00:00:00Z",
"external_id": "ext_id_12345678",
"fp_id": "fp_id_7p793EF07xKXHqAeg5VGPj",
"id": "bank_link_x134ssf3rsdf",
"institution_id": "inst_12345",
"institution_logo": "https://example.com/chase.png",
"institution_name": "Chase Bank",
"products": {
"account_numbers": {
"last_attempted_at": "2023-05-15T14:30:00Z",
"refreshed_at": "2023-05-15T14:30:00Z"
},
"accounts": {
"last_attempted_at": "2023-05-15T14:30:00Z",
"refreshed_at": "2023-05-15T14:30:00Z"
},
"transactions": {
"last_attempted_at": "2023-05-15T14:30:00Z",
"refreshed_at": "2023-05-15T14:30:00Z"
}
},
"provider": "akoya",
"state": "connected",
"tags": [
"my_tag"
]
}