openbankproject_client.account_access module

Account Access endpoints for the OpenBankProject API Client.

class openbankproject_client.account_access.AccountAccessEndpoints(client)[source]

Bases: object

Account Access-related API endpoints.

__init__(client)[source]

Initialize the endpoint group.

Parameters:

client – OpenBankProjectClient instance

get_account_access(bank_id: str, account_id: str, view_id: str) → Dict[source]

Get Account Access.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

Returns:

Dict containing account access information

grant_user_access_to_view(bank_id: str, account_id: str, view_id: str, data: Dict) → Dict[source]

Grant User Access to View.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • data – User access data

Returns:

Dict containing granted access information

revoke_user_access_to_view(bank_id: str, account_id: str, view_id: str, user_id: str) → Dict[source]

Revoke User Access to View.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

  • user_id – User identifier

Returns:

Dict containing revocation status

get_users_with_access_to_view(bank_id: str, account_id: str, view_id: str) → Dict[source]

Get Users with Access to View.

Parameters:

  • bank_id – Bank identifier

  • account_id – Account identifier

  • view_id – View identifier

Returns:

Dict containing users with access information