Get Residuals Report for External Accounts Connections

This endpoint returns a residuals report of external account connections grouped by customer profile. The report provides visibility into which external accounts have been linked via third-party providers (such as Finicity or Plaid) within a specified date range. Results are paginated and can be filtered to specific profiles by ID.

Endpoint

GET /Report/residuals/externalAccountsConnections

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 a reconciliation or audit report of external account connections made by customers during a given time window. This is particularly useful for partners tracking ACH-linked accounts, monitoring third-party provider usage (Finicity or Plaid), or generating residual activity reports for billing or compliance purposes.

Query Parameters

Response

200 OK

Returns an array of profile external account connection groups. Each item in the array represents a profile with all of its associated external account connections.

Top-level array item (profileexternalaccountconnectiongrouped):

Each item in connections (externalaccountconnection or profileexternalaccountconnection):

[
  {
    "id": 1042,
    "name": "Acme Corp",
    "connections": [
      {
        "connectionDate": "2024-03-15T10:22:00Z",
        "provider": "Plaid",
        "id": 1042,
        "name": "Acme Corp"
      },
      {
        "connectionDate": "2024-03-20T14:05:00Z",
        "provider": "Finicity"
      }
    ]
  },
  {
    "id": 1087,
    "name": "Bright Path LLC",
    "connections": [
      {
        "connectionDate": "2024-03-18T09:10:00Z",
        "provider": "Plaid",
        "id": 1087,
        "name": "Bright Path LLC"
      }
    ]
  }
]

Error Codes

Common Mistakes

• Providing from or to in a non-ISO 8601 date-time format — always use YYYY-MM-DDTHH:mm:ssZ format.
• Omitting the Authorization: Bearer header or using an expired token, resulting in a 401 error.
• Passing a take value that is very large without also setting skip, which may result in slow responses for high-volume datasets — use pagination to iterate through results.
• Passing ids as a comma-separated string instead of repeated query parameters (e.g., use ids=1042&ids=1087 not ids=1042,1087).

Related Endpoints

• GET /Report/residuals/cards — Retrieve residuals report for card activity
• GET /Report/residuals/accounts — Retrieve residuals report for financial accounts
• POST /api/auth/v2 — Obtain a Bearer token for authentication
• POST /api/auth/refresh — Refresh an existing Bearer token

Example

curl -X GET "https://api.banking.netevia.dev/Report/residuals/externalAccountsConnections?from=2024-03-01T00%3A00%3A00Z&to=2024-03-31T23%3A59%3A59Z&skip=0&take=100" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"