Check External Accounts Limit

The Check External Accounts Limit endpoint returns the configured maximum number of external accounts a customer is permitted to link to their financial account. This allows partners and customers to verify their remaining capacity before initiating an external account connection via Finicity or Plaid. Use this endpoint proactively to prevent integration errors caused by exceeding the allowed limit.

Endpoint

GET /api/financialAccounts/externalAccountsLimit

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

Call this endpoint before attempting to link a new external account to determine whether the customer has capacity remaining. It is also useful in account management UIs to display the allowed limit alongside the current count of linked external accounts. The limit may differ between personal and business customer account types.

Response

200 OK

{
  "value": 5
}

Error Codes

Common Mistakes

• Confusing the limit returned here with the current count of linked accounts — this endpoint returns only the maximum allowed, not how many are currently linked.
• Not refreshing the Bearer token before calling this endpoint; tokens expire after 10 minutes and will result in a 401 error.

Related Endpoints

• GET /api/financialAccounts — List all financial accounts for the authenticated customer
• POST /api/financialAccounts/externalAccounts — Link a new external account via Finicity or Plaid
• GET /api/financialAccounts/externalAccounts — Retrieve currently linked external accounts

Example

curl -X GET https://api.banking.netevia.dev/api/financialAccounts/externalAccountsLimit \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"