Attach financial account to Authorized user

Attach Financial Account to Authorized User

This endpoint links a financial account to an authorized user (subProfile) associated with a business customer. By providing the subProfile ID and the target financial account ID, you grant the authorized user access to that account. This supports granular access control and organized account management across your banking application.

Endpoint

POST /api/subProfiles/attachToFinancialAccount

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 onboarding a new authorized user to a business account and you need to grant them access to one or more specific financial accounts. It is also useful when an existing authorized user's access scope needs to be expanded to include an additional financial account. This endpoint is applicable to business customers only, as subProfiles are not available for personal customers.

Request Body

FieldTypeRequiredDescription
financialAccountIdstringYesThe unique identifier of the financial account to attach to the authorized user.
subProfileIdinteger (int32)YesThe unique identifier of the authorized user (subProfile) to whom the financial account will be linked.
{
  "financialAccountId": "fa_abc123def456",
  "subProfileId": 1042
}

Response

200 OK

A successful response confirms that the financial account has been linked to the authorized user. The response body is empty on success.

{}

Error Codes

CodeWhen it happens
400Missing required fields (financialAccountId or subProfileId), or values fail validation (e.g., empty string for financialAccountId)
401Token missing, expired, or invalid
403Insufficient permissions to attach accounts to the specified subProfile
404The specified financialAccountId or subProfileId does not exist
500Internal server error

Common Mistakes

  • Passing financialAccountId as an empty string — the field has a minimum length of 1 and will fail validation.
  • Attempting to use this endpoint for personal customers — subProfiles are a business-customer-only feature.
  • Using an integer for financialAccountId instead of the string identifier returned when the financial account was created.
  • Providing a subProfileId that belongs to a different partner or business customer than the financial account, resulting in a 403 or 404 error.

Related Endpoints

  • POST /api/subProfiles — Create a new authorized user (subProfile) for a business customer
  • GET /api/subProfiles/{subProfileId} — Retrieve details of an authorized user
  • DELETE /api/subProfiles/detachFromFinancialAccount — Remove a financial account link from an authorized user
  • GET /api/financialAccounts — List financial accounts available for the customer

Example

curl -X POST https://api.banking.netevia.dev/api/subProfiles/attachToFinancialAccount \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "financialAccountId": "fa_abc123def456",
    "subProfileId": 1042
  }'
Body Params
string
required
length ≥ 1
int32
required
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response
200

Success

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