Get external accounts

Get External Accounts

The Get External Accounts endpoint retrieves a comprehensive list of external accounts linked to a specific customer profile. Each returned account includes details such as account type, balance information, account status, and the provider through which the account was connected. This endpoint supports financial oversight by allowing partners to surface all externally linked accounts for a given customer in a single call.

Endpoint

GET /netevia/externalAccounts/{profileId}

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint when you need to display or audit all external financial accounts a customer has linked to their profile, such as accounts connected via Finicity or Plaid. It is commonly called during account management flows, before initiating ACH transfers, or when presenting a consolidated view of a customer's external banking relationships.

Path Parameters

ParameterTypeRequiredDescription
profileIdinteger (int32)YesThe unique numeric identifier of the customer profile whose external accounts are to be retrieved.

Response

200 OK

Returns an array of external financial account objects.

externalfinancialaccount object

FieldTypeDescription
typenamestringThe type name label for the external account.
externalBankAccountTypeinteger (enum)Numeric code representing the external bank account type.
idstringUnique identifier of the external account record.
namestringDisplay name of the external account.
externalBankAccountDetailsobjectDetailed bank account information (see sub-fields below).
providerstringThe provider used to link the account (e.g., Finicity, Plaid).
createdAtstring (date-time)Timestamp when the external account was linked.
accountStatusstringCurrent status of the external account (e.g., active, inactive).
updatedAtstring (date-time)Timestamp of the most recent update to the account record.
bankNamestringName of the external financial institution.
ownersanyAccount owner information, if available.
balanceInfoobjectBalance details for the account (see sub-fields below).

externalBankAccountDetails sub-fields

FieldTypeDescription
last4stringLast four digits of the external account number.
typestringAccount subtype (e.g., checking, savings).
routingNumberstringABA routing number of the external bank.
createdAtstring (date-time)Timestamp when the account detail record was created.
updatedAtstring (date-time)Timestamp when the account detail record was last updated.
accountNumberstringFull account number (masked in display contexts).

balanceInfo sub-fields

FieldTypeDescription
datestring (date-time)Date and time the balance was last retrieved.
valuenumber (double)Balance amount.
currencystringCurrency code for the balance (e.g., USD).
[
  {
    "typename": "ExternalBankAccount",
    "externalBankAccountType": 0,
    "id": "ext-acct-00112233",
    "name": "My Checking Account",
    "externalBankAccountDetails": {
      "last4": "4321",
      "type": "checking",
      "routingNumber": "021000021",
      "createdAt": "2025-03-10T08:00:00Z",
      "updatedAt": "2025-03-10T08:00:00Z",
      "accountNumber": "XXXXXXXXXX"
    },
    "provider": "Plaid",
    "createdAt": "2025-03-10T08:00:00Z",
    "accountStatus": "active",
    "updatedAt": "2026-01-15T12:30:00Z",
    "bankName": "Chase Bank",
    "owners": null,
    "balanceInfo": {
      "date": "2026-06-08T00:00:00Z",
      "value": 1540.75,
      "currency": "USD"
    }
  }
]

Error Codes

CodeWhen it happens
400The profileId is not a valid integer or is malformed.
401Token missing, expired, or invalid.
403Insufficient permissions to access the specified profile.
404No profile found for the given profileId.
500Internal server error while retrieving external accounts.

Common Mistakes

  • Passing a non-integer or string value for profileId — the field must be a valid int32.
  • Expecting a single object in the response — the endpoint always returns an array, even if only one account is linked.
  • Assuming accountNumber in externalBankAccountDetails is always populated — some providers return only last4 and omit the full account number.
  • Not refreshing the Bearer token before calling this endpoint — tokens expire after 10 minutes and will return a 401 error.

Related Endpoints

  • POST /netevia/externalAccounts — Link a new external account to a customer profile via Finicity or Plaid.
  • DELETE /netevia/externalAccounts/{profileId}/{accountId} — Remove a linked external account from a customer profile.
  • GET /netevia/profile/{profileId} — Retrieve the customer profile associated with the given profile ID.

Example

curl -X GET https://api.banking.netevia.dev/netevia/externalAccounts/98765 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
Path Params
int32
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json