Account Access

How account access and Views work in OBP.

Account Access and Views

In OBP, access to account data is controlled through Views. Views determine which fields of an account or transaction are visible to which users. This mechanism enables fine-grained access control without duplicating data.

What is a View?

A View is a named access level on an account. Each account can have multiple Views, and each View defines which data fields are visible. Common Views include:

ViewDescription
ownerFull access — all fields visible. Only the account holder has this by default.
accountantAccess to financial data like balances and transactions, but may hide personal details.
auditorRead-only access for audit purposes.
publicFields visible to anyone without authentication (if enabled).

Banks and account holders can also create custom Views to tailor access for specific use cases.

How Access Works

When you call an account endpoint, you specify a VIEW_ID in the URL. The API returns only the fields permitted by that View for your user:

GET /obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/account

If you don't have access to the requested View, the API returns an error.

Listing Available Views

To see which Views you have access to on an account(see in API Explorer):

GET /obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views

Granting Access

Account owners can grant other users access to a View on their account(see in API Explorer):

POST https://YOUR_OBP_HOST/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/account-access/grant

{
  "user_id": "USER_ID_TO_GRANT"
}

Revoking Access

To revoke a user's access to a View(see in API Explorer):

POST https://YOUR_OBP_HOST/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/account-access/revoke

{
  "user_id": "USER_ID_TO_REVOKE"
}

Creating Custom Views

You can create custom Views to define exactly which fields are visible. This is useful for sharing limited account access with third parties, accountants, or internal teams.

POST https://YOUR_OBP_HOST/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/owner/target-views

{
  "name": "my-custom-view",
  "description": "Limited view for my accountant",
  "metadata_view": "owner",
  "is_public": false,
  "which_alias_to_use": "none",
  "hide_metadata_if_alias_used": false,
  "allowed_actions": [
    "can_see_transaction_this_bank_account",
    "can_see_transaction_amount",
    "can_see_transaction_currency",
    "can_see_bank_account_balance"
  ]
}

Views and Consents

When creating a Consent for a third-party app, you specify which Views the app can access. This means the account holder controls exactly what data the third party can see, combining the consent mechanism with View-based access control.

Related