Banking User

Verwaltung der Bankbenutzer

put

Path parameters

userIdinteger · int64Required

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

usernamestringRequired

username

passwordstringWrite-onlyOptional

password

emailstringRequired

email

replicatedbooleanRead-onlyOptional

is user replicated

Default: false

requiredUserActionstring · enumOptional

type of required user action

Possible values:

autoUpdateEnabledbooleanOptional

Is autoupdate on finAPI active

Responses

200

OK

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

usernamestringRequired

username

passwordstringWrite-onlyOptional

password

emailstringRequired

email

replicatedbooleanRead-onlyOptional

is user replicated

Default: false

requiredUserActionstring · enumOptional

type of required user action

Possible values:

autoUpdateEnabledbooleanOptional

Is autoupdate on finAPI active

put/banking/banking-user/{userId}

HTTPcURLJavaScriptPython

PUT /api/banking/banking-user/{userId} HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "version": "text",
  "info": {},
  "id": "text",
  "bankingProviderRef": {
    "id": "text"
  },
  "username": "text",
  "password": "text",
  "email": "text",
  "requiredUserAction": "NO_ACTION_REQUIRED",
  "autoUpdateEnabled": true,
  "varioUserRef": {
    "id": "text"
  }
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T01:06:26.714Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T01:06:26.714Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "bankingProviderRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "username": "text",
  "email": "text",
  "replicated": false,
  "requiredUserAction": "NO_ACTION_REQUIRED",
  "autoUpdateEnabled": true,
  "varioUserRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

put

Path parameters

userIdinteger · int64Required

Responses

200

OK

application/json

contextstringOptional

message context

messageValuestringOptional

message

put/banking/banking-user/{userId}/check_user_state

HTTPcURLJavaScriptPython

PUT /api/banking/banking-user/{userId}/check_user_state HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "context": "text",
  "messageValue": "text"
}

post

Path parameters

userIdinteger · int64Required

Responses

200

OK

application/json

contextstringOptional

message context

messageValuestringOptional

message

post/banking/banking-user/{userId}/replicate

HTTPcURLJavaScriptPython

POST /api/banking/banking-user/{userId}/replicate HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "context": "text",
  "messageValue": "text"
}

post

Path parameters

bankingProviderIdinteger · int64Required

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

usernamestringRequired

username

passwordstringWrite-onlyOptional

password

emailstringRequired

email

replicatedbooleanRead-onlyOptional

is user replicated

Default: false

requiredUserActionstring · enumOptional

type of required user action

Possible values:

autoUpdateEnabledbooleanOptional

Is autoupdate on finAPI active

Responses

200

OK

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

usernamestringRequired

username

passwordstringWrite-onlyOptional

password

emailstringRequired

email

replicatedbooleanRead-onlyOptional

is user replicated

Default: false

requiredUserActionstring · enumOptional

type of required user action

Possible values:

autoUpdateEnabledbooleanOptional

Is autoupdate on finAPI active

post/banking/banking-user/create/{bankingProviderId}

HTTPcURLJavaScriptPython

POST /api/banking/banking-user/create/{bankingProviderId} HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "version": "text",
  "info": {},
  "id": "text",
  "bankingProviderRef": {
    "id": "text"
  },
  "username": "text",
  "password": "text",
  "email": "text",
  "requiredUserAction": "NO_ACTION_REQUIRED",
  "autoUpdateEnabled": true,
  "varioUserRef": {
    "id": "text"
  }
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T01:06:26.714Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T01:06:26.714Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "bankingProviderRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "username": "text",
  "email": "text",
  "replicated": false,
  "requiredUserAction": "NO_ACTION_REQUIRED",
  "autoUpdateEnabled": true,
  "varioUserRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

get

Path parameters

userIdinteger · int64Required

bankingProviderIdinteger · int64Required

Responses

200

OK

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

usernamestringRequired

username

passwordstringWrite-onlyOptional

password

emailstringRequired

email

replicatedbooleanRead-onlyOptional

is user replicated

Default: false

requiredUserActionstring · enumOptional

type of required user action

Possible values:

autoUpdateEnabledbooleanOptional

Is autoupdate on finAPI active

get/banking/banking-user/{userId}/get_external_user/{bankingProviderId}

HTTPcURLJavaScriptPython

GET /api/banking/banking-user/{userId}/get_external_user/{bankingProviderId} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T01:06:26.714Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T01:06:26.714Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "bankingProviderRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "username": "text",
  "email": "text",
  "replicated": false,
  "requiredUserAction": "NO_ACTION_REQUIRED",
  "autoUpdateEnabled": true,
  "varioUserRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

Checks if the connector can connect

get

Path parameters

userIdinteger · int64Required

Responses

200

successful operation

application/json

contextstringOptional

message context

messageValuestringOptional

message

get/banking/banking-user/{userId}/check_login_with_user

HTTPcURLJavaScriptPython

GET /api/banking/banking-user/{userId}/check_login_with_user HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

successful operation

{
  "context": "text",
  "messageValue": "text"
}

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

usernamestringRequired

username

passwordstringWrite-onlyOptional

password

emailstringRequired

email

replicatedbooleanRead-onlyOptional

is user replicated

Default: false

requiredUserActionstring · enumOptional

type of required user action

Possible values:

autoUpdateEnabledbooleanOptional

Is autoupdate on finAPI active

404

Resource with given ID was not found

application/json

get/banking/banking-user/{id}

HTTPcURLJavaScriptPython

GET /api/banking/banking-user/{id} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T01:06:26.714Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T01:06:26.714Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "bankingProviderRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "username": "text",
  "email": "text",
  "replicated": false,
  "requiredUserAction": "NO_ACTION_REQUIRED",
  "autoUpdateEnabled": true,
  "varioUserRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

contextstringOptional

message context

messageValuestringOptional

message

404

Resource was not found

application/json

409

unable to delete Resource, due to constraints, existing references or internal state

application/json

delete/banking/banking-user/{id}

HTTPcURLJavaScriptPython

DELETE /api/banking/banking-user/{id} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

get

Responses

200

OK

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

usernamestringRequired

username

passwordstringWrite-onlyOptional

password

emailstringRequired

email

replicatedbooleanRead-onlyOptional

is user replicated

Default: false

requiredUserActionstring · enumOptional

type of required user action

Possible values:

autoUpdateEnabledbooleanOptional

Is autoupdate on finAPI active

get/banking/banking-user/users

HTTPcURLJavaScriptPython

GET /api/banking/banking-user/users HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[]

get

Path parameters

bankIdinteger · int64Required

Responses

200

OK

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

activebooleanRead-onlyOptional

Is the user active?

Default: true

usernamestringOptional

username

firstNamestringOptional

first-name

lastNamestringOptional

last-name

emailAddressstringOptional

email-address

ownerbooleanRead-onlyOptional

Is owner user?

Default: false

emailVerifiedbooleanRead-onlyOptional

is the email verified

Default: false

validTostring · date-timeOptional

Valid to

typestring · enumOptional

User type

Possible values:

appIdentifierstring · uuidRead-onlyOptional

App-Identifier

referencedCustomerUserIdinteger · int64Read-onlyOptional

Referenzierte Kundenbenutzer ID (CustomerUserEntity.id aus vab-manager)

get/banking/banking-user/get_users_for_bank/{bankId}

HTTPcURLJavaScriptPython

GET /api/banking/banking-user/get_users_for_bank/{bankId} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[]

get

Path parameters

accountIdinteger · int64Required

Responses

200

OK

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

usernamestringRequired

username

passwordstringWrite-onlyOptional

password

emailstringRequired

email

replicatedbooleanRead-onlyOptional

is user replicated

Default: false

requiredUserActionstring · enumOptional

type of required user action

Possible values:

autoUpdateEnabledbooleanOptional

Is autoupdate on finAPI active

get/banking/banking-user/get_bankinguser/{accountId}

HTTPcURLJavaScriptPython

GET /api/banking/banking-user/get_bankinguser/{accountId} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[]