Retrieving Connection Requests

Retrieving Connection Requests

This endpoint returns a list of all connection requests made by accounts associated with a specified banking profile, including both primary and sub-accounts. It is used to inspect which remote accounts have been requested for linking. A security check is enforced to ensure that only the API-User associated with the profile can access its connection requests.

Endpoint

GET /api/LinkedAccount/{id}

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 audit or display the external account linking activity for a customer profile. It is useful for partner dashboards that show pending or accepted connection requests, and for verifying the status of linked external accounts before initiating transfers.

Path Parameters

ParameterTypeRequiredDescription
idinteger (int32)YesThe ID of the banking profile (primary, sub, or consumer) whose connection requests you want to retrieve.

Response

200 OK

Returns an array of connection request objects. Each object has the following fields:

FieldTypeDescription
idintegerUnique identifier of the connection request record.
fromUserIdintegerID of the user who initiated the connection request.
toUserIdintegerID of the user to whom the connection request was sent.
profileIdintegerID of the banking profile associated with this connection request.
dbastring"Doing Business As" name for the account, if applicable (nullable).
nickNamestringNickname assigned to the linked account (nullable).
firstNamestringFirst name of the account holder (nullable).
lastNamestringLast name of the account holder (nullable).
isSubUserbooleanIndicates whether the requesting party is a sub-user (authorized user).
acceptedbooleanIndicates whether the connection request has been accepted.
createdDatestring (date-time)Timestamp when the connection request was created.
typeintegerUser type enumeration: 1, 2, 3, 4, or 5.
statusstringCurrent status of the connection request (nullable).
[
  {
    "id": 1042,
    "fromUserId": 3011,
    "toUserId": 3087,
    "profileId": 8821,
    "dba": "Acme Retail LLC",
    "nickName": "Main Checking",
    "firstName": "Jane",
    "lastName": "Smith",
    "isSubUser": false,
    "accepted": true,
    "createdDate": "2025-03-15T10:22:00Z",
    "type": 2,
    "status": "Active"
  },
  {
    "id": 1043,
    "fromUserId": 3011,
    "toUserId": 3099,
    "profileId": 8821,
    "dba": null,
    "nickName": "Savings",
    "firstName": "John",
    "lastName": "Doe",
    "isSubUser": true,
    "accepted": false,
    "createdDate": "2025-04-01T08:45:00Z",
    "type": 1,
    "status": "Pending"
  }
]

Error Codes

CodeWhen it happens
400The provided id is not a valid integer or is malformed.
401Token missing, expired, or invalid.
403The authenticated API-User does not have permission to access the specified profile's connection requests.
404No banking profile found for the given id.
500Internal server error.

Common Mistakes

  • Providing a non-integer value for the id path parameter — the schema requires a 32-bit integer.
  • Attempting to retrieve connection requests for a profile that belongs to a different partner — the security check will return 403.
  • Confusing the profile id with a user ID or account ID; the id must reference a valid banking profile.
  • Not handling a null response for nullable fields such as dba, nickName, firstName, lastName, and status when parsing the response.

Related Endpoints

  • POST /api/LinkedAccount — Create a new connection request to link an external account to a banking profile.
  • DELETE /api/LinkedAccount/{id} — Remove an existing linked account connection request.
  • GET /api/LinkedAccount — Retrieve all linked account connection requests (if available without a profile filter).

Example

curl -X GET https://api.banking.netevia.dev/api/LinkedAccount/8821 \
  -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