Get Linked Account Users

This endpoint retrieves all external accounts that have been granted permission to connect to the authenticated customer's account. Only connections that have been explicitly confirmed by the customer are included in the response. The result is an array of account objects, each containing identity and connection details for the linked external account.

Endpoint

GET /api/LinkedAccount/users

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 a customer's list of approved external account connections, such as in an account management dashboard. It is also useful when verifying which external parties currently have access to a customer's account before adding or revoking connections. Only confirmed (accepted) links are returned, so the result reflects the current active connection state.

Response

200 OK

[
  {
    "id": 1042,
    "fromUserId": 3001,
    "toUserId": 4055,
    "profileId": 2087,
    "nickName": "jane.smith",
    "firstName": "Jane",
    "lastName": "Smith",
    "dba": null,
    "type": 1,
    "isSubUser": false,
    "accepted": true,
    "status": "Active",
    "createdDate": "2025-03-15T10:22:00Z"
  },
  {
    "id": 1098,
    "fromUserId": 3210,
    "toUserId": 4055,
    "profileId": 2301,
    "nickName": "acme-corp",
    "firstName": "Acme",
    "lastName": "Corp",
    "dba": "Acme Corporation",
    "type": 2,
    "isSubUser": false,
    "accepted": true,
    "status": "Active",
    "createdDate": "2025-04-02T08:45:00Z"
  }
]

Error Codes

Common Mistakes

• Only confirmed connections are returned. If a connection request was sent but not yet accepted by the customer, it will not appear in this response.
• The type field uses integer enum values, not strings. Ensure your application maps 1 to Consumer, 2 to Business primary, and 4 to Business sub-account accordingly.
• The dba field is only populated for business-type accounts. Do not rely on it being present for consumer accounts.
• This endpoint is called using the bank customer's own credentials. The Bearer token must correspond to the customer whose linked accounts you wish to retrieve.

Related Endpoints

• POST /api/LinkedAccount/request — Send a connection request to link an external account
• DELETE /api/LinkedAccount/{id} — Remove an existing linked account connection
• GET /api/LinkedAccount/requests — Retrieve pending (unconfirmed) connection requests

Example

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