Create Linked Account Access Request

Sends an access request to another Netevia customer's account, initiating a pending connection that requires the customer's approval.

Create Linked Account Access Request

This endpoint creates an access request to link with another Netevia bank customer's account. The request is placed in a pending state until the target customer reviews and approves or denies the connection. Use this endpoint to initiate account linkages between Netevia customers, enabling features such as transfers and shared account visibility.

Endpoint

POST /api/LinkedAccount/request

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 a customer wants to initiate a connection to another Netevia account holder by username. The target account holder will receive a pending request that must be approved before the link is active. This is the first step in establishing a linked account relationship that can later support internal transfers and shared access.

Query Parameters

ParameterTypeRequiredDescription
userNamestringYesThe username (nickname) of the Netevia account to which access is being requested.

Response

200 OK

Returns an array of pending connection requests that have been sent but not yet confirmed by the target customer. Each object in the array represents a single pending request.

FieldTypeDescription
idstringUnique identifier for the connection request.
nickNamestringUsername or nickname of the external account that was requested.
firstNamestringFirst name of the external account holder.
lastNamestringLast name of the external account holder.
dbastringBusiness name under which the account operates (applicable to business and sub-accounts).
typeintegerType of the external account: 1 = Consumer account, 2 = Business primary account, 4 = Business sub-account.
[
  {
    "id": "req_a1b2c3d4e5f6",
    "nickName": "jane.doe",
    "firstName": "Jane",
    "lastName": "Doe",
    "dba": "",
    "type": 1
  },
  {
    "id": "req_b2c3d4e5f6a1",
    "nickName": "acme.corp",
    "firstName": "John",
    "lastName": "Smith",
    "dba": "Acme Corporation",
    "type": 2
  }
]

Error Codes

CodeWhen it happens
400Missing or invalid userName query parameter
401Token missing, expired, or invalid
403Insufficient permissions to create a linked account request
404Target account with the specified userName not found
500Internal server error

Common Mistakes

  • Omitting the userName query parameter — it is required for the request to be routed to the correct target account.
  • Using an email address or account number instead of the account's userName (nickname) field.
  • Attempting to send a duplicate request to an account that already has a pending or active connection.
  • Confusing the response array (pending outbound requests) with a confirmation of immediate connection — the target customer must still approve before the link becomes active.

Related Endpoints

  • GET /api/LinkedAccount/request — Retrieve the list of pending inbound connection requests awaiting the authenticated customer's approval.
  • PUT /api/LinkedAccount/request — Approve or deny a pending inbound connection request.
  • GET /api/LinkedAccount — List all active linked accounts for the authenticated customer.
  • DELETE /api/LinkedAccount/{id} — Remove an existing linked account connection.

Example

curl -X POST "https://api.banking.netevia.dev/api/LinkedAccount/request?userName=jane.doe" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
Query Params
string
Response
200

Success

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!