Check Available Funds

Check Available Funds Possible custom URL parameters for pagination:

amount=NUMBER
currency=STRING

Typical Successful Response:

								
									{
  "answer":"yes",
  "date":"2019-01-27T04:01:29Z",
  "available_funds_request_id":"c4ykz59svsr9b7fmdxk8ezs7"
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-20054: Invalid amount. Please specify a valid value for amount.
OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
OBP-50000: Unknown Error.

Implmented in 3_1_0 by checkFundsAvailable

Create Account

Create Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID.

The User can create an Account for themself or an Account for another User if they have CanCreateAccount role.

If USER_ID is not specified the account will be owned by the logged in User.

Note: The Amount must be zero.

Typical Successful Response:

								
									{
  "user_id":"66214b8e-259e-44ad-8868-3eb47be70646",
  "label":"Label",
  "type":"CURRENT",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "branch_id":"1234",
  "account_routing":{
    "scheme":"OBP",
    "address":"UK123456"
  }
}

Headers:

Required Roles:

CanCreateAccount - Please login to request this Role

Possible Errors:

OBP-10001: Incorrect json format.
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-20001: User not logged in. Authentication is required!
OBP-30107: Invalid User Id.
OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
OBP-20005: User not found. Please specify a valid value for USER_ID.
OBP-20006: User is missing one or more roles:
OBP-30106: Invalid Balance Amount.
OBP-30112: Invalid Number. Initial balance must be a number, e.g 1000.00
OBP-30109: Initial Balance of Account must be Zero (0).
OBP-30105: Invalid Balance Currency.
OBP-30208: Account_ID already exists at the Bank.
OBP-50000: Unknown Error.

Implmented in 2_2_0 by createAccount

Get Account by Id (Core)

Information returned about the account specified by ACCOUNT_ID:

Number - The human readable account number given by the bank that identifies the account.
Label - A label given by the owner of the account
Owners - Users that own this account
Type - The type of account
Balance - Currency and Value
Account Routings - A list that might include IBAN or national account identifiers
Account Rules - A list that might include Overdraft and other bank specific rules

This call returns the owner view and requires access to that view.

Authentication is Mandatory

Typical Successful Response:

								
									{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "bank_id":"String",
  "label":"String",
  "number":"String",
  "owners":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"OBP",
    "display_name":"OBP"
  }],
  "type":"String",
  "balance":{
    "currency":"EUR",
    "amount":"10"
  },
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "account_rules":[{
    "scheme":"OVERDRAFT",
    "value":"10"
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-50000: Unknown Error.

Implmented in 3_0_0 by getCoreAccountById

Get Account by Id (Full)

Information returned about an account specified by ACCOUNT_ID as moderated by the view (VIEW_ID):

Number
Owners
Type
Balance
IBAN
Available views (sorted by short_name)

More details about the data moderation by the view here.

PSD2 Context: PSD2 requires customers to have access to their account information via third party applications. This call provides balance and other account information via delegated authentication using OAuth.

Authentication is required if the 'is_public' field in view (VIEW_ID) is not set to true.

Typical Successful Response:

								
									{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "bank_id":"String",
  "label":"String",
  "number":"String",
  "owners":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"OBP",
    "display_name":"OBP"
  }],
  "type":"String",
  "balance":{
    "currency":"EUR",
    "amount":"10"
  },
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "account_rules":[{
    "scheme":"OVERDRAFT",
    "value":"10"
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
OBP-50000: Unknown Error.

Implmented in 3_0_0 by getPrivateAccountById

Get Accounts Held

Get Accounts held by the current User if even the User has not been assigned the owner View yet.

Can be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.

Authentication is Mandatory

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"12314",
    "bank_id":"123",
    "number":"123",
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }]
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-50000: Unknown Error.

Implmented in 3_0_0 by getAccountsHeld

Get Accounts at Bank (IDs only).

Returns only the list of accounts ids at BANK_ID that the user has access to.

Each account must have at least one private View.

For each account the API returns its account ID.

If you want to see more information on the Views, use the Account Detail call.

Authentication is Mandatory

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf"
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-50000: Unknown Error.

Implmented in 3_0_0 by getPrivateAccountIdsbyBankId

Get Accounts at Bank (Minimal).

Returns the minimal list of private accounts at BANK_ID that the user has access to. For each account, the API returns the ID, routing addresses and the views available to the current user.

If you want to see more information on the Views, use the Account Detail call.

Authentication is Mandatory

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "label":"String",
    "bank_id":"gh.29.uk",
    "account_type":"330",
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "views":[{
      "id":"123",
      "short_name":"short_name",
      "description":"description",
      "is_public":false
    }]
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-50000: Unknown Error.

Implmented in 3_0_0 by privateAccountsAtOneBank

Get Accounts at Bank.

Returns the list of accounts at BANK_ID that the user has access to. For each account the API returns the account ID and the views available to the user.. Each account must have at least one private View.

Authentication is Mandatory

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "label":"NoneLabel",
    "bank_id":"gh.29.uk",
    "views_available":[{
      "id":"1",
      "short_name":"HHH",
      "is_public":true
    }]
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-50000: Unknown Error.

Implmented in 2_0_0 by getPrivateAccountsAtOneBank

Get Accounts at all Banks (private)

Returns the list of accounts containing private views for the user. Each account lists the views available to the user.

Authentication is Mandatory

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "label":"String",
    "bank_id":"gh.29.uk",
    "account_type":"330",
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "views":[{
      "id":"123",
      "short_name":"short_name",
      "description":"description",
      "is_public":false
    }]
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Implmented in 3_0_0 by corePrivateAccountsAllBanks

Update Account Label.

Update the label for the account. The label is how the account is known to the account owner e.g. 'My savings account'

Authentication is Mandatory

Typical Successful Response:

								
									{
  "success":"Success"
}

Headers:

Required Roles:

Possible Errors:

OBP-10001: Incorrect json format.
OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
user does not have access to owner view on account

Implmented in 1_2_1 by updateAccountLabel

Create Account Application

Authentication is Mandatory

Typical Successful Response:

								
									{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"saveing1",
  "user":{
    "user_id":"123",
    "email":"contact@tesobe.com",
    "provider_id":"obp",
    "provider":"obp",
    "username":"TESOBE"
  },
  "customer":{
    "bank_id":"bankid1234",
    "customer_id":"123",
    "customer_number":"123",
    "legal_name":"legal_name",
    "mobile_phone_number":"123",
    "email":"contact@tesobe.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"2017-09-19T00:00:00Z"
    },
    "date_of_birth":"2017-09-19T00:00:00Z",
    "relationship_status":"123",
    "dependants":123,
    "dob_of_dependants":["2017-09-19T00:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"10"
    },
    "highest_education_attained":"123",
    "employment_status":"123",
    "kyc_status":true,
    "last_ok_date":"2017-09-19T00:00:00Z",
    "title":"Dr.",
    "branchId":"12314",
    "nameSuffix":"Sr"
  },
  "date_of_application":"2017-09-19T00:00:00Z",
  "status":"REQUESTED"
}

Headers:

Required Roles:

Possible Errors:

OBP-10001: Incorrect json format.
OBP-50000: Unknown Error.

Implmented in 3_1_0 by createAccountApplication

Get Account Application by Id

Get the Account Application.

Authentication is Mandatory

Typical Successful Response:

								
									{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"saveing1",
  "user":{
    "user_id":"123",
    "email":"contact@tesobe.com",
    "provider_id":"obp",
    "provider":"obp",
    "username":"TESOBE"
  },
  "customer":{
    "bank_id":"bankid1234",
    "customer_id":"123",
    "customer_number":"123",
    "legal_name":"legal_name",
    "mobile_phone_number":"123",
    "email":"contact@tesobe.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"2017-09-19T00:00:00Z"
    },
    "date_of_birth":"2017-09-19T00:00:00Z",
    "relationship_status":"123",
    "dependants":123,
    "dob_of_dependants":["2017-09-19T00:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"10"
    },
    "highest_education_attained":"123",
    "employment_status":"123",
    "kyc_status":true,
    "last_ok_date":"2017-09-19T00:00:00Z",
    "title":"Dr.",
    "branchId":"12314",
    "nameSuffix":"Sr"
  },
  "date_of_application":"2017-09-19T00:00:00Z",
  "status":"REQUESTED"
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Implmented in 3_1_0 by getAccountApplication

Get Account Applications

Get the Account Applications.

Authentication is Mandatory

Typical Successful Response:

								
									{
  "account_applications":[{
    "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
    "product_code":"saveing1",
    "user":{
      "user_id":"123",
      "email":"contact@tesobe.com",
      "provider_id":"obp",
      "provider":"obp",
      "username":"TESOBE"
    },
    "customer":{
      "bank_id":"bankid1234",
      "customer_id":"123",
      "customer_number":"123",
      "legal_name":"legal_name",
      "mobile_phone_number":"123",
      "email":"contact@tesobe.com",
      "face_image":{
        "url":"www.openbankproject",
        "date":"2017-09-19T00:00:00Z"
      },
      "date_of_birth":"2017-09-19T00:00:00Z",
      "relationship_status":"123",
      "dependants":123,
      "dob_of_dependants":["2017-09-19T00:00:00Z"],
      "credit_rating":{
        "rating":"OBP",
        "source":"OBP"
      },
      "credit_limit":{
        "currency":"EUR",
        "amount":"10"
      },
      "highest_education_attained":"123",
      "employment_status":"123",
      "kyc_status":true,
      "last_ok_date":"2017-09-19T00:00:00Z",
      "title":"Dr.",
      "branchId":"12314",
      "nameSuffix":"Sr"
    },
    "date_of_application":"2017-09-19T00:00:00Z",
    "status":"REQUESTED"
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Implmented in 3_1_0 by getAccountApplications

Update Account Application Status

Update an Account Application status

Authentication is Mandatory

Typical Successful Response:

								
									{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"saveing1",
  "user":{
    "user_id":"123",
    "email":"contact@tesobe.com",
    "provider_id":"obp",
    "provider":"obp",
    "username":"TESOBE"
  },
  "customer":{
    "bank_id":"bankid1234",
    "customer_id":"123",
    "customer_number":"123",
    "legal_name":"legal_name",
    "mobile_phone_number":"123",
    "email":"contact@tesobe.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"2017-09-19T00:00:00Z"
    },
    "date_of_birth":"2017-09-19T00:00:00Z",
    "relationship_status":"123",
    "dependants":123,
    "dob_of_dependants":["2017-09-19T00:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"10"
    },
    "highest_education_attained":"123",
    "employment_status":"123",
    "kyc_status":true,
    "last_ok_date":"2017-09-19T00:00:00Z",
    "title":"Dr.",
    "branchId":"12314",
    "nameSuffix":"Sr"
  },
  "date_of_application":"2017-09-19T00:00:00Z",
  "status":"REQUESTED"
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Implmented in 3_1_0 by updateAccountApplicationStatus

Get Firehose Accounts at Bank

Get Accounts which have a firehose view assigned to them.

This endpoint allows bulk access to accounts.

Requires the CanUseFirehoseAtAnyBank Role

To be shown on the list, each Account must have a firehose View linked to it.

For VIEW_ID try 'owner'

Authentication is Mandatory

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "bank_id":"String",
    "label":"String",
    "number":"String",
    "owners":[{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"OBP",
      "display_name":"OBP"
    }],
    "type":"String",
    "balance":{
      "currency":"EUR",
      "amount":"10"
    },
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "account_rules":[{
      "scheme":"OVERDRAFT",
      "value":"10"
    }]
  }]
}

Headers:

Required Roles:

CanUseFirehoseAtAnyBank - Please login to request this Role

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Implmented in 3_0_0 by getFirehoseAccountsAtOneBank

Get Firehose Customers

Get Customers that has a firehose View.

Allows bulk access to customers. User must have the CanUseFirehoseAtAnyBank Role

Possible custom URL parameters for pagination:

sort_direction=ASC/DESC
limit=NUMBER ==> default value: 50
offset=NUMBER ==> default value: 0
from_date=DATE => default value: date of the oldest customer created (format below)
to_date=DATE => default value: date of the newest customer created (format below)

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.

Authentication is Mandatory

Typical Successful Response:

								
									{
  "transactions":[{
    "id":"String",
    "this_account":{
      "id":"String",
      "bank_routing":{
        "scheme":"Bank_ID",
        "address":"gh.29.uk"
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }],
      "holders":[{
        "name":"OBP",
        "is_alias":true
      }]
    },
    "other_account":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "holder":{
        "name":"OBP",
        "is_alias":true
      },
      "bank_routing":{
        "scheme":"Bank_ID",
        "address":"gh.29.uk"
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }],
      "metadata":{
        "public_alias":"NONE",
        "private_alias":"NONE",
        "more_info":"www.openbankproject.com",
        "URL":"www.openbankproject.com",
        "image_URL":"www.openbankproject.com",
        "open_corporates_URL":"www.openbankproject.com",
        "corporate_location":{
          "latitude":1.231,
          "longitude":1.231,
          "date":"2017-09-19T00:00:00Z",
          "user":{
            "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
            "provider":"OBP",
            "display_name":"OBP"
          }
        },
        "physical_location":{
          "latitude":1.231,
          "longitude":1.231,
          "date":"2017-09-19T00:00:00Z",
          "user":{
            "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
            "provider":"OBP",
            "display_name":"OBP"
          }
        }
      }
    },
    "details":{
      "type":"AC",
      "description":"this is for family",
      "posted":"2017-09-19T00:00:00Z",
      "completed":"2017-09-19T00:00:00Z",
      "new_balance":{
        "currency":"EUR",
        "amount":"10"
      },
      "value":{
        "currency":"EUR",
        "amount":"10"
      }
    },
    "metadata":{
      "narrative":"NONE",
      "comments":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "value":"OBP",
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }],
      "tags":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "value":"OBP",
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }],
      "images":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "label":"NONE",
        "URL":"www.openbankproject.com",
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }],
      "where":{
        "latitude":1.231,
        "longitude":1.231,
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }
    }
  }]
}

Headers:

Required Roles:

CanUseFirehoseAtAnyBank - Please login to request this Role

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-00009: Firehose views not allowed on this instance. Please set allow_firehose_views = true in props files.
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Implmented in 3_1_0 by getFirehoseCustomers

Get Firehose Transactions for Account

Get Transactions for an Account that has a firehose View.

Allows bulk access to an account's transactions. User must have the CanUseFirehoseAtAnyBank Role

To find ACCOUNT_IDs, use the getFirehoseAccountsAtOneBank call.

For VIEW_ID try 'owner'

Authentication is Mandatory

Typical Successful Response:

								
									{
  "transactions":[{
    "id":"String",
    "this_account":{
      "id":"String",
      "bank_routing":{
        "scheme":"Bank_ID",
        "address":"gh.29.uk"
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }],
      "holders":[{
        "name":"OBP",
        "is_alias":true
      }]
    },
    "other_account":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "holder":{
        "name":"OBP",
        "is_alias":true
      },
      "bank_routing":{
        "scheme":"Bank_ID",
        "address":"gh.29.uk"
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }],
      "metadata":{
        "public_alias":"NONE",
        "private_alias":"NONE",
        "more_info":"www.openbankproject.com",
        "URL":"www.openbankproject.com",
        "image_URL":"www.openbankproject.com",
        "open_corporates_URL":"www.openbankproject.com",
        "corporate_location":{
          "latitude":1.231,
          "longitude":1.231,
          "date":"2017-09-19T00:00:00Z",
          "user":{
            "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
            "provider":"OBP",
            "display_name":"OBP"
          }
        },
        "physical_location":{
          "latitude":1.231,
          "longitude":1.231,
          "date":"2017-09-19T00:00:00Z",
          "user":{
            "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
            "provider":"OBP",
            "display_name":"OBP"
          }
        }
      }
    },
    "details":{
      "type":"AC",
      "description":"this is for family",
      "posted":"2017-09-19T00:00:00Z",
      "completed":"2017-09-19T00:00:00Z",
      "new_balance":{
        "currency":"EUR",
        "amount":"10"
      },
      "value":{
        "currency":"EUR",
        "amount":"10"
      }
    },
    "metadata":{
      "narrative":"NONE",
      "comments":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "value":"OBP",
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }],
      "tags":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "value":"OBP",
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }],
      "images":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "label":"NONE",
        "URL":"www.openbankproject.com",
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }],
      "where":{
        "latitude":1.231,
        "longitude":1.231,
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }
    }
  }]
}

Headers:

Required Roles:

CanUseFirehoseAtAnyBank - Please login to request this Role

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-00009: Firehose views not allowed on this instance. Please set allow_firehose_views = true in props files.
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Implmented in 3_0_0 by getFirehoseTransactionsForBankAccount

Get Public Account by Id

Returns information about an account that has a public view.

The account is specified by ACCOUNT_ID. The information is moderated by the view specified by VIEW_ID.

Number
Owners
Type
Balance
Routing

PSD2 Context: PSD2 requires customers to have access to their account information via third party applications. This call provides balance and other account information via delegated authentication using OAuth.

Authentication is Optional

Typical Successful Response:

								
									{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "bank_id":"String",
  "label":"String",
  "number":"String",
  "owners":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"OBP",
    "display_name":"OBP"
  }],
  "type":"String",
  "balance":{
    "currency":"EUR",
    "amount":"10"
  },
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "account_rules":[{
    "scheme":"OVERDRAFT",
    "value":"10"
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50000: Unknown Error.

Implmented in 3_0_0 by getPublicAccountById

Get Public Accounts at Bank

Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.

Authentication is Optional

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "label":"NoneLabel",
    "bank_id":"gh.29.uk",
    "views_available":[{
      "id":"1",
      "short_name":"HHH",
      "is_public":true
    }]
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-50000: Unknown Error.

Implmented in 2_0_0 by publicAccountsAtOneBank

Get Public Accounts at all Banks.

Get public accounts at all banks (Anonymous access). Returns accounts that contain at least one public view (a view where is_public is true) For each account the API returns the ID and the available views.

Authentication is Optional

Typical Successful Response:

								
									{
  "accounts":[{
    "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "label":"NoneLabel",
    "bank_id":"gh.29.uk",
    "views_available":[{
      "id":"1",
      "short_name":"HHH",
      "is_public":true
    }]
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
Could not get accounts.
OBP-50000: Unknown Error.

Implmented in 2_0_0 by publicAccountsAllBanks

Create Counterparty (Explicit)

Create Counterparty (Explicit) for an Account.

In OBP, there are two types of Counterparty.

Explicit Counterparties (those here) which we create explicitly and are used in COUNTERPARTY Transaction Requests
Implicit Counterparties (AKA Other Accounts) which are generated automatically from the other sides of Transactions.

Explicit Counterparties are created for the account / view They are how the user of the view (e.g. account owner) refers to the other side of the transaction

name : the human readable name (e.g. Piano teacher, Miss Nipa)

description : the human readable name (e.g. Piano teacher, Miss Nipa)

bank_routing_scheme : eg: bankId or bankCode or any other strings

bank_routing_address : eg: gh.29.uk, must be valid sandbox bankIds

account_routing_scheme : eg: AccountId or AccountNumber or any other strings

account_routing_address : eg: 1d65db7c-a7b2-4839-af41-95, must be valid accountIds

other_account_secondary_routing_scheme : eg: IBan or any other strings

other_account_secondary_routing_address : if it is IBan, it should be unique for each counterparty.

other_branch_routing_scheme : eg: branchId or any other strings or you can leave it empty, not useful in sandbox mode.

other_branch_routing_address : eg: branch-id-123 or you can leave it empty, not useful in sandbox mode.

is_beneficiary : must be set to true in order to send payments to this counterparty

bespoke: It support list of key-value, you can add it to the counterarty.

bespoke.key : any info-key you want to add to this counerparty

bespoke.value : any info-value you want to add to this counerparty

The view specified by VIEW_ID must have the canAddCounterparty permission

A minimal example for TransactionRequestType == COUNTERPARTY { "name": "Tesobe1", "description": "Good Company", "other_bank_routing_scheme": "bankId", "other_bank_routing_address": "gh.29.uk", "other_account_routing_scheme": "accountId", "other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "is_beneficiary": true, "other_account_secondary_routing_scheme": "", "other_account_secondary_routing_address": "", "other_branch_routing_scheme": "", "other_branch_routing_address": "", "bespoke": [] }

A minimal example for TransactionRequestType == SEPA

{ "name": "Tesobe2", "description": "Good Company", "other_bank_routing_scheme": "bankId", "other_bank_routing_address": "gh.29.uk", "other_account_routing_scheme": "accountId", "other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "other_account_secondary_routing_scheme": "IBAN", "other_account_secondary_routing_address": "DE89 3704 0044 0532 0130 00", "is_beneficiary": true, "other_branch_routing_scheme": "", "other_branch_routing_address": "", "bespoke": [] }

Authentication is Mandatory

Typical Successful Response:

								
									{
  "name":"CounterpartyName",
  "description":"My landlord",
  "created_by_user_id":"49e1e147-64c1-4823-ad9f-89efcd02a9fa",
  "this_bank_id":"gh.29.uk",
  "this_account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
  "this_view_id":"owner",
  "counterparty_id":"1d65db7c-a7b2-4839-af41-958276ab7790",
  "other_bank_routing_scheme":"bankCode",
  "other_bank_routing_address":"10",
  "other_branch_routing_scheme":"branchNumber",
  "other_branch_routing_address":"10010",
  "other_account_routing_scheme":"accountNumber",
  "other_account_routing_address":"7987987-2348987-234234",
  "other_account_secondary_routing_scheme":"accountId",
  "other_account_secondary_routing_address":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
  "is_beneficiary":true,
  "bespoke":[{
    "key":"englishName",
    "value":"english Name"
  }],
  "metadata":{
    "publicAlias":"String",
    "moreInfo":null,
    "url":null,
    "imageURL":null,
    "openCorporatesURL":null,
    "corporateLocation":null,
    "physicalLocation":null,
    "privateAlias":null
  }
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
OBP-10001: Incorrect json format.
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-30014: Counterparty already exists. Please specify a different value for BANK_ID or ACCOUNT_ID or VIEW_ID or NAME.
OBP-50000: Unknown Error.

Implmented in 2_2_0 by createCounterparty

Get Counterparties (Explicit).

Get the Counterparties (Explicit) for the account / view.

Authentication is Mandatory

Typical Successful Response:

								
									{
  "counterparties":[{
    "name":"CounterpartyName",
    "description":"My landlord",
    "created_by_user_id":"49e1e147-64c1-4823-ad9f-89efcd02a9fa",
    "this_bank_id":"gh.29.uk",
    "this_account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "this_view_id":"owner",
    "counterparty_id":"1d65db7c-a7b2-4839-af41-958276ab7790",
    "other_bank_routing_scheme":"bankCode",
    "other_bank_routing_address":"10",
    "other_branch_routing_scheme":"branchNumber",
    "other_branch_routing_address":"10010",
    "other_account_routing_scheme":"accountNumber",
    "other_account_routing_address":"7987987-2348987-234234",
    "other_account_secondary_routing_scheme":"accountId",
    "other_account_secondary_routing_address":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
    "is_beneficiary":true,
    "bespoke":[{
      "key":"englishName",
      "value":"english Name"
    }]
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-30022: The current view does not have the permission:
OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
OBP-50000: Unknown Error.

Implmented in 2_2_0 by getExplictCounterpartiesForAccount

Get Other Account by Id.

Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID. Authentication is Optional

Authentication is required if the view is not public.

Typical Successful Response:

								
									{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "holder":{
    "name":"OBP",
    "is_alias":true
  },
  "bank_routing":{
    "scheme":"Bank_ID",
    "address":"gh.29.uk"
  },
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "metadata":{
    "public_alias":"NONE",
    "private_alias":"NONE",
    "more_info":"www.openbankproject.com",
    "URL":"www.openbankproject.com",
    "image_URL":"www.openbankproject.com",
    "open_corporates_URL":"www.openbankproject.com",
    "corporate_location":{
      "latitude":1.231,
      "longitude":1.231,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "provider":"OBP",
        "display_name":"OBP"
      }
    },
    "physical_location":{
      "latitude":1.231,
      "longitude":1.231,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "provider":"OBP",
        "display_name":"OBP"
      }
    }
  }
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50200: Connector cannot return the data we requested.
OBP-50000: Unknown Error.

Implmented in 3_0_0 by getOtherAccountByIdForBankAccount

Get Other Accounts of one Account.

Returns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID. Authentication is Optional

Authentication is required if the view VIEW_ID is not public.

Typical Successful Response:

								
									{
  "other_accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "holder":{
      "name":"OBP",
      "is_alias":true
    },
    "bank_routing":{
      "scheme":"Bank_ID",
      "address":"gh.29.uk"
    },
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "metadata":{
      "public_alias":"NONE",
      "private_alias":"NONE",
      "more_info":"www.openbankproject.com",
      "URL":"www.openbankproject.com",
      "image_URL":"www.openbankproject.com",
      "open_corporates_URL":"www.openbankproject.com",
      "corporate_location":{
        "latitude":1.231,
        "longitude":1.231,
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      },
      "physical_location":{
        "latitude":1.231,
        "longitude":1.231,
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }
    }
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50200: Connector cannot return the data we requested.
OBP-50000: Unknown Error.

Implmented in 3_0_0 by getOtherAccountsForBankAccount

Get Transactions for Account (Core)

Returns transactions list (Core info) of the account specified by ACCOUNT_ID.

Authentication is Mandatory

Possible custom headers for pagination:

sort_direction=ASC/DESC ==> default value: DESC. The sort field is the completed date.
limit=NUMBER ==> default value: 50
offset=NUMBER ==> default value: 0
from_date=DATE => default value: 0000-00-00T00:00:00.000Z
to_date=DATE => default value: 3049-01-01T00:00:00.000Z

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.

Typical Successful Response:

								
									{
  "transactions":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "this_account":{
      "id":"String",
      "bank_routing":{
        "scheme":"Bank_ID",
        "address":"gh.29.uk"
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }],
      "holders":[{
        "name":"OBP",
        "is_alias":true
      }]
    },
    "other_account":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "holder":{
        "name":"OBP",
        "is_alias":true
      },
      "bank_routing":{
        "scheme":"Bank_ID",
        "address":"gh.29.uk"
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }]
    },
    "details":{
      "type":"AC",
      "description":"OBP",
      "posted":"2017-09-19T00:00:00Z",
      "completed":"2017-09-19T00:00:00Z",
      "new_balance":{
        "currency":"EUR",
        "amount":"10"
      },
      "value":{
        "currency":"EUR",
        "amount":"10"
      }
    }
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC!
OBP-10024: wrong value for obp_offset parameter. Please send a positive integer (=>0)!
OBP-10025: wrong value for obp_limit parameter. Please send a positive integer (=>1)!
OBP-10026: Failed to parse date string. Please use this format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'!
OBP-20001: User not logged in. Authentication is required!
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50000: Unknown Error.

Implmented in 3_0_0 by getCoreTransactionsForBankAccount

Get Transactions for Account (Full)

Returns transactions list of the account specified by ACCOUNT_ID and moderated by the view (VIEW_ID).

Authentication is Optional

Authentication is required if the view is not public.

Possible custom headers for pagination:

sort_direction=ASC/DESC ==> default value: DESC. The sort field is the completed date.
limit=NUMBER ==> default value: 50
offset=NUMBER ==> default value: 0
from_date=DATE => default value: 0000-00-00T00:00:00.000Z
to_date=DATE => default value: 3049-01-01T00:00:00.000Z

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.

Typical Successful Response:

								
									{
  "transactions":[{
    "id":"String",
    "this_account":{
      "id":"String",
      "bank_routing":{
        "scheme":"Bank_ID",
        "address":"gh.29.uk"
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }],
      "holders":[{
        "name":"OBP",
        "is_alias":true
      }]
    },
    "other_account":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "holder":{
        "name":"OBP",
        "is_alias":true
      },
      "bank_routing":{
        "scheme":"Bank_ID",
        "address":"gh.29.uk"
      },
      "account_routings":[{
        "scheme":"AccountNumber",
        "address":"4930396"
      }],
      "metadata":{
        "public_alias":"NONE",
        "private_alias":"NONE",
        "more_info":"www.openbankproject.com",
        "URL":"www.openbankproject.com",
        "image_URL":"www.openbankproject.com",
        "open_corporates_URL":"www.openbankproject.com",
        "corporate_location":{
          "latitude":1.231,
          "longitude":1.231,
          "date":"2017-09-19T00:00:00Z",
          "user":{
            "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
            "provider":"OBP",
            "display_name":"OBP"
          }
        },
        "physical_location":{
          "latitude":1.231,
          "longitude":1.231,
          "date":"2017-09-19T00:00:00Z",
          "user":{
            "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
            "provider":"OBP",
            "display_name":"OBP"
          }
        }
      }
    },
    "details":{
      "type":"AC",
      "description":"this is for family",
      "posted":"2017-09-19T00:00:00Z",
      "completed":"2017-09-19T00:00:00Z",
      "new_balance":{
        "currency":"EUR",
        "amount":"10"
      },
      "value":{
        "currency":"EUR",
        "amount":"10"
      }
    },
    "metadata":{
      "narrative":"NONE",
      "comments":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "value":"OBP",
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }],
      "tags":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "value":"OBP",
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }],
      "images":[{
        "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
        "label":"NONE",
        "URL":"www.openbankproject.com",
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }],
      "where":{
        "latitude":1.231,
        "longitude":1.231,
        "date":"2017-09-19T00:00:00Z",
        "user":{
          "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
          "provider":"OBP",
          "display_name":"OBP"
        }
      }
    }
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC!
OBP-10024: wrong value for obp_offset parameter. Please send a positive integer (=>0)!
OBP-10025: wrong value for obp_limit parameter. Please send a positive integer (=>1)!
OBP-10026: Failed to parse date string. Please use this format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'!
OBP-20001: User not logged in. Authentication is required!
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50000: Unknown Error.

Implmented in 3_0_0 by getTransactionsForBankAccount

Create View.

Create a view on bank account

Authentication is Mandatory and the user needs to have access to the owner view. The 'alias' field in the JSON can take one of three values:

public: to use the public alias if there is one specified for the other account.
private: to use the public alias if there is one specified for the other account.
''(empty string): to use no alias; the view shows the real name of the other account.

The 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to true and there is an alias on the other account then the other accounts' metadata (like more_info, url, image_url, open_corporates_url, etc.) will be hidden. Otherwise the metadata will be shown.

The 'allowed_actions' field is a list containing the name of the actions allowed on this view, all the actions contained will be set to true on the view creation, the rest will be set to false.

You MUST use a leading _ (underscore) in the view name because other view names are reserved for OBP system views.

Typical Successful Response:

								
									{
  "id":"1234",
  "short_name":"short_name",
  "description":"description",
  "metadata_view":"owner",
  "is_public":true,
  "alias":"No",
  "hide_metadata_if_alias_used":true,
  "can_add_comment":true,
  "can_add_corporate_location":true,
  "can_add_image":true,
  "can_add_image_url":true,
  "can_add_more_info":true,
  "can_add_open_corporates_url":true,
  "can_add_physical_location":true,
  "can_add_private_alias":true,
  "can_add_public_alias":true,
  "can_add_tag":true,
  "can_add_url":true,
  "can_add_where_tag":true,
  "can_delete_comment":true,
  "can_add_counterparty":true,
  "can_delete_corporate_location":true,
  "can_delete_image":true,
  "can_delete_physical_location":true,
  "can_delete_tag":true,
  "can_delete_where_tag":true,
  "can_edit_owner_comment":true,
  "can_see_bank_account_balance":true,
  "can_query_available_funds":true,
  "can_see_bank_account_bank_name":true,
  "can_see_bank_account_currency":true,
  "can_see_bank_account_iban":true,
  "can_see_bank_account_label":true,
  "can_see_bank_account_national_identifier":true,
  "can_see_bank_account_number":true,
  "can_see_bank_account_owners":true,
  "can_see_bank_account_swift_bic":true,
  "can_see_bank_account_type":true,
  "can_see_comments":true,
  "can_see_corporate_location":true,
  "can_see_image_url":true,
  "can_see_images":true,
  "can_see_more_info":true,
  "can_see_open_corporates_url":true,
  "can_see_other_account_bank_name":true,
  "can_see_other_account_iban":true,
  "can_see_other_account_kind":true,
  "can_see_other_account_metadata":true,
  "can_see_other_account_national_identifier":true,
  "can_see_other_account_number":true,
  "can_see_other_account_swift_bic":true,
  "can_see_owner_comment":true,
  "can_see_physical_location":true,
  "can_see_private_alias":true,
  "can_see_public_alias":true,
  "can_see_tags":true,
  "can_see_transaction_amount":true,
  "can_see_transaction_balance":true,
  "can_see_transaction_currency":true,
  "can_see_transaction_description":true,
  "can_see_transaction_finish_date":true,
  "can_see_transaction_metadata":true,
  "can_see_transaction_other_bank_account":true,
  "can_see_transaction_start_date":true,
  "can_see_transaction_this_bank_account":true,
  "can_see_transaction_type":true,
  "can_see_url":true,
  "can_see_where_tag":true,
  "can_see_bank_routing_scheme":true,
  "can_see_bank_routing_address":true,
  "can_see_bank_account_routing_scheme":true,
  "can_see_bank_account_routing_address":true,
  "can_see_other_bank_routing_scheme":true,
  "can_see_other_bank_routing_address":true,
  "can_see_other_account_routing_scheme":true,
  "can_see_other_account_routing_address":true,
  "can_add_transaction_request_to_own_account":true,
  "can_add_transaction_request_to_any_account":true,
  "can_see_bank_account_credit_limit":true
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-10001: Incorrect json format.
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-50000: Unknown Error.

Implmented in 3_0_0 by createViewForBankAccount

Delete View

Deletes the view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID.

Typical Successful Response:

								
									{
  "jsonString":"{}"
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-50000: Unknown Error.
user does not have owner access

Implmented in 1_2_1 by deleteViewForBankAccount

Get Account access for User.

Returns the list of the views at BANK_ID for account ACCOUNT_ID that a user identified by PROVIDER_ID at their provider PROVIDER has access to. All url parameters must be %-encoded, which is often especially relevant for USER_ID and PROVIDER.

Authentication is Mandatory

The user needs to have access to the owner view.

Typical Successful Response:

								
									{
  "views":[{
    "id":"1234",
    "short_name":"short_name",
    "description":"description",
    "metadata_view":"owner",
    "is_public":true,
    "alias":"No",
    "hide_metadata_if_alias_used":true,
    "can_add_comment":true,
    "can_add_corporate_location":true,
    "can_add_image":true,
    "can_add_image_url":true,
    "can_add_more_info":true,
    "can_add_open_corporates_url":true,
    "can_add_physical_location":true,
    "can_add_private_alias":true,
    "can_add_public_alias":true,
    "can_add_tag":true,
    "can_add_url":true,
    "can_add_where_tag":true,
    "can_delete_comment":true,
    "can_add_counterparty":true,
    "can_delete_corporate_location":true,
    "can_delete_image":true,
    "can_delete_physical_location":true,
    "can_delete_tag":true,
    "can_delete_where_tag":true,
    "can_edit_owner_comment":true,
    "can_see_bank_account_balance":true,
    "can_query_available_funds":true,
    "can_see_bank_account_bank_name":true,
    "can_see_bank_account_currency":true,
    "can_see_bank_account_iban":true,
    "can_see_bank_account_label":true,
    "can_see_bank_account_national_identifier":true,
    "can_see_bank_account_number":true,
    "can_see_bank_account_owners":true,
    "can_see_bank_account_swift_bic":true,
    "can_see_bank_account_type":true,
    "can_see_comments":true,
    "can_see_corporate_location":true,
    "can_see_image_url":true,
    "can_see_images":true,
    "can_see_more_info":true,
    "can_see_open_corporates_url":true,
    "can_see_other_account_bank_name":true,
    "can_see_other_account_iban":true,
    "can_see_other_account_kind":true,
    "can_see_other_account_metadata":true,
    "can_see_other_account_national_identifier":true,
    "can_see_other_account_number":true,
    "can_see_other_account_swift_bic":true,
    "can_see_owner_comment":true,
    "can_see_physical_location":true,
    "can_see_private_alias":true,
    "can_see_public_alias":true,
    "can_see_tags":true,
    "can_see_transaction_amount":true,
    "can_see_transaction_balance":true,
    "can_see_transaction_currency":true,
    "can_see_transaction_description":true,
    "can_see_transaction_finish_date":true,
    "can_see_transaction_metadata":true,
    "can_see_transaction_other_bank_account":true,
    "can_see_transaction_start_date":true,
    "can_see_transaction_this_bank_account":true,
    "can_see_transaction_type":true,
    "can_see_url":true,
    "can_see_where_tag":true,
    "can_see_bank_routing_scheme":true,
    "can_see_bank_routing_address":true,
    "can_see_bank_account_routing_scheme":true,
    "can_see_bank_account_routing_address":true,
    "can_see_other_bank_routing_scheme":true,
    "can_see_other_bank_routing_address":true,
    "can_see_other_account_routing_scheme":true,
    "can_see_other_account_routing_address":true,
    "can_add_transaction_request_to_own_account":true,
    "can_add_transaction_request_to_any_account":true,
    "can_see_bank_account_credit_limit":true
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
OBP-50000: Unknown Error.

Implmented in 3_0_0 by getPermissionForUserForBankAccount

Get Views for Account.

Views

Views in Open Bank Project provide a mechanism for fine grained access control and delegation to Accounts and Transactions. Account holders use the 'owner' view by default. Delegated access is made through other views for example 'accountants', 'share-holders' or 'tagging-application'. Views can be created via the API and each view has a list of entitlements.

Views on accounts and transactions filter the underlying data to redact certain fields for certain users. For instance the balance on an account may be hidden from the public. The way to know what is possible on a view is determined in the following JSON.

Data: When a view moderates a set of data, some fields my contain the value null rather than the original value. This indicates either that the user is not allowed to see the original data or the field is empty.

There is currently one exception to this rule; the 'holder' field in the JSON contains always a value which is either an alias or the real name - indicated by the 'is_alias' field.

Action: When a user performs an action like trying to post a comment (with POST API call), if he is not allowed, the body response will contain an error message.

Metadata: Transaction metadata (like images, tags, comments, etc.) will appears ONLY on the view where they have been created e.g. comments posted to the public view only appear on the public view.

The other account metadata fields (like image_URL, more_info, etc.) are unique through all the views. Example, if a user edits the 'more_info' field in the 'team' view, then the view 'authorities' will show the new value (if it is allowed to do it).

All

Optional

Returns the list of the views created for account ACCOUNT_ID at BANK_ID.

Authentication is Mandatory and the user needs to have access to the owner view.

Typical Successful Response:

								
									{
  "views":[{
    "id":"1234",
    "short_name":"short_name",
    "description":"description",
    "metadata_view":"owner",
    "is_public":true,
    "alias":"No",
    "hide_metadata_if_alias_used":true,
    "can_add_comment":true,
    "can_add_corporate_location":true,
    "can_add_image":true,
    "can_add_image_url":true,
    "can_add_more_info":true,
    "can_add_open_corporates_url":true,
    "can_add_physical_location":true,
    "can_add_private_alias":true,
    "can_add_public_alias":true,
    "can_add_tag":true,
    "can_add_url":true,
    "can_add_where_tag":true,
    "can_delete_comment":true,
    "can_add_counterparty":true,
    "can_delete_corporate_location":true,
    "can_delete_image":true,
    "can_delete_physical_location":true,
    "can_delete_tag":true,
    "can_delete_where_tag":true,
    "can_edit_owner_comment":true,
    "can_see_bank_account_balance":true,
    "can_query_available_funds":true,
    "can_see_bank_account_bank_name":true,
    "can_see_bank_account_currency":true,
    "can_see_bank_account_iban":true,
    "can_see_bank_account_label":true,
    "can_see_bank_account_national_identifier":true,
    "can_see_bank_account_number":true,
    "can_see_bank_account_owners":true,
    "can_see_bank_account_swift_bic":true,
    "can_see_bank_account_type":true,
    "can_see_comments":true,
    "can_see_corporate_location":true,
    "can_see_image_url":true,
    "can_see_images":true,
    "can_see_more_info":true,
    "can_see_open_corporates_url":true,
    "can_see_other_account_bank_name":true,
    "can_see_other_account_iban":true,
    "can_see_other_account_kind":true,
    "can_see_other_account_metadata":true,
    "can_see_other_account_national_identifier":true,
    "can_see_other_account_number":true,
    "can_see_other_account_swift_bic":true,
    "can_see_owner_comment":true,
    "can_see_physical_location":true,
    "can_see_private_alias":true,
    "can_see_public_alias":true,
    "can_see_tags":true,
    "can_see_transaction_amount":true,
    "can_see_transaction_balance":true,
    "can_see_transaction_currency":true,
    "can_see_transaction_description":true,
    "can_see_transaction_finish_date":true,
    "can_see_transaction_metadata":true,
    "can_see_transaction_other_bank_account":true,
    "can_see_transaction_start_date":true,
    "can_see_transaction_this_bank_account":true,
    "can_see_transaction_type":true,
    "can_see_url":true,
    "can_see_where_tag":true,
    "can_see_bank_routing_scheme":true,
    "can_see_bank_routing_address":true,
    "can_see_bank_account_routing_scheme":true,
    "can_see_bank_account_routing_address":true,
    "can_see_other_bank_routing_scheme":true,
    "can_see_other_bank_routing_address":true,
    "can_see_other_account_routing_scheme":true,
    "can_see_other_account_routing_address":true,
    "can_add_transaction_request_to_own_account":true,
    "can_add_transaction_request_to_any_account":true,
    "can_see_bank_account_credit_limit":true
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-50000: Unknown Error.

Implmented in 3_0_0 by getViewsForBankAccount

Get access.

Returns the list of the permissions at BANK_ID for account ACCOUNT_ID, with each time a pair composed of the user and the views that he has access to.

Authentication is Mandatory and the user needs to have access to the owner view.

Typical Successful Response:

								
									{
  "permissions":[{
    "user":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"OBP",
      "display_name":"OBP"
    },
    "views":[{
      "id":"123",
      "short_name":"short_name",
      "description":"description",
      "is_public":true,
      "alias":"None",
      "hide_metadata_if_alias_used":true,
      "can_add_comment":true,
      "can_add_corporate_location":true,
      "can_add_image":true,
      "can_add_image_url":true,
      "can_add_more_info":true,
      "can_add_open_corporates_url":true,
      "can_add_physical_location":true,
      "can_add_private_alias":true,
      "can_add_public_alias":true,
      "can_add_tag":true,
      "can_add_url":true,
      "can_add_where_tag":true,
      "can_delete_comment":true,
      "can_delete_corporate_location":true,
      "can_delete_image":true,
      "can_delete_physical_location":true,
      "can_delete_tag":true,
      "can_delete_where_tag":true,
      "can_edit_owner_comment":true,
      "can_see_bank_account_balance":true,
      "can_see_bank_account_bank_name":true,
      "can_see_bank_account_currency":true,
      "can_see_bank_account_iban":true,
      "can_see_bank_account_label":true,
      "can_see_bank_account_national_identifier":true,
      "can_see_bank_account_number":true,
      "can_see_bank_account_owners":true,
      "can_see_bank_account_swift_bic":true,
      "can_see_bank_account_type":true,
      "can_see_comments":true,
      "can_see_corporate_location":true,
      "can_see_image_url":true,
      "can_see_images":true,
      "can_see_more_info":true,
      "can_see_open_corporates_url":true,
      "can_see_other_account_bank_name":true,
      "can_see_other_account_iban":true,
      "can_see_other_account_kind":true,
      "can_see_other_account_metadata":true,
      "can_see_other_account_national_identifier":true,
      "can_see_other_account_number":true,
      "can_see_other_account_swift_bic":true,
      "can_see_owner_comment":true,
      "can_see_physical_location":true,
      "can_see_private_alias":true,
      "can_see_public_alias":true,
      "can_see_tags":true,
      "can_see_transaction_amount":true,
      "can_see_transaction_balance":true,
      "can_see_transaction_currency":true,
      "can_see_transaction_description":true,
      "can_see_transaction_finish_date":true,
      "can_see_transaction_metadata":true,
      "can_see_transaction_other_bank_account":true,
      "can_see_transaction_start_date":true,
      "can_see_transaction_this_bank_account":true,
      "can_see_transaction_type":true,
      "can_see_url":true,
      "can_see_where_tag":true
    }]
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
OBP-50000: Unknown Error.

Implmented in 2_0_0 by getPermissionsForBankAccount

Grant User access to View.

Grants the User identified by PROVIDER_ID at PROVIDER access to the view VIEW_ID at BANK_ID for account ACCOUNT_ID.

All url parameters must be %-encoded, which is often especially relevant for PROVIDER and PROVIDER_ID.

Authentication is Mandatory and the user needs to have access to the owner view.

Granting access to a public view will return an error message, as the user already has access.

Typical Successful Response:

								
									{
  "id":"123",
  "short_name":"short_name",
  "description":"description",
  "is_public":true,
  "alias":"None",
  "hide_metadata_if_alias_used":true,
  "can_add_comment":true,
  "can_add_corporate_location":true,
  "can_add_image":true,
  "can_add_image_url":true,
  "can_add_more_info":true,
  "can_add_open_corporates_url":true,
  "can_add_physical_location":true,
  "can_add_private_alias":true,
  "can_add_public_alias":true,
  "can_add_tag":true,
  "can_add_url":true,
  "can_add_where_tag":true,
  "can_delete_comment":true,
  "can_delete_corporate_location":true,
  "can_delete_image":true,
  "can_delete_physical_location":true,
  "can_delete_tag":true,
  "can_delete_where_tag":true,
  "can_edit_owner_comment":true,
  "can_see_bank_account_balance":true,
  "can_see_bank_account_bank_name":true,
  "can_see_bank_account_currency":true,
  "can_see_bank_account_iban":true,
  "can_see_bank_account_label":true,
  "can_see_bank_account_national_identifier":true,
  "can_see_bank_account_number":true,
  "can_see_bank_account_owners":true,
  "can_see_bank_account_swift_bic":true,
  "can_see_bank_account_type":true,
  "can_see_comments":true,
  "can_see_corporate_location":true,
  "can_see_image_url":true,
  "can_see_images":true,
  "can_see_more_info":true,
  "can_see_open_corporates_url":true,
  "can_see_other_account_bank_name":true,
  "can_see_other_account_iban":true,
  "can_see_other_account_kind":true,
  "can_see_other_account_metadata":true,
  "can_see_other_account_national_identifier":true,
  "can_see_other_account_number":true,
  "can_see_other_account_swift_bic":true,
  "can_see_owner_comment":true,
  "can_see_physical_location":true,
  "can_see_private_alias":true,
  "can_see_public_alias":true,
  "can_see_tags":true,
  "can_see_transaction_amount":true,
  "can_see_transaction_balance":true,
  "can_see_transaction_currency":true,
  "can_see_transaction_description":true,
  "can_see_transaction_finish_date":true,
  "can_see_transaction_metadata":true,
  "can_see_transaction_other_bank_account":true,
  "can_see_transaction_start_date":true,
  "can_see_transaction_this_bank_account":true,
  "can_see_transaction_type":true,
  "can_see_url":true,
  "can_see_where_tag":true
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-50000: Unknown Error.
could not save the privilege
user does not have access to owner view on account

Implmented in 1_2_1 by addPermissionForUserForBankAccountForOneView

Grant User access to a list of views.

Grants the user identified by PROVIDER_ID at their provider PROVIDER access to a list of views at BANK_ID for account ACCOUNT_ID.

All url parameters must be %-encoded, which is often especially relevant for PROVIDER_ID and PROVIDER.

Authentication is Mandatory

The User needs to have access to the owner view.

Typical Successful Response:

								
									{
  "views":[{
    "id":"123",
    "short_name":"short_name",
    "description":"description",
    "is_public":true,
    "alias":"None",
    "hide_metadata_if_alias_used":true,
    "can_add_comment":true,
    "can_add_corporate_location":true,
    "can_add_image":true,
    "can_add_image_url":true,
    "can_add_more_info":true,
    "can_add_open_corporates_url":true,
    "can_add_physical_location":true,
    "can_add_private_alias":true,
    "can_add_public_alias":true,
    "can_add_tag":true,
    "can_add_url":true,
    "can_add_where_tag":true,
    "can_delete_comment":true,
    "can_delete_corporate_location":true,
    "can_delete_image":true,
    "can_delete_physical_location":true,
    "can_delete_tag":true,
    "can_delete_where_tag":true,
    "can_edit_owner_comment":true,
    "can_see_bank_account_balance":true,
    "can_see_bank_account_bank_name":true,
    "can_see_bank_account_currency":true,
    "can_see_bank_account_iban":true,
    "can_see_bank_account_label":true,
    "can_see_bank_account_national_identifier":true,
    "can_see_bank_account_number":true,
    "can_see_bank_account_owners":true,
    "can_see_bank_account_swift_bic":true,
    "can_see_bank_account_type":true,
    "can_see_comments":true,
    "can_see_corporate_location":true,
    "can_see_image_url":true,
    "can_see_images":true,
    "can_see_more_info":true,
    "can_see_open_corporates_url":true,
    "can_see_other_account_bank_name":true,
    "can_see_other_account_iban":true,
    "can_see_other_account_kind":true,
    "can_see_other_account_metadata":true,
    "can_see_other_account_national_identifier":true,
    "can_see_other_account_number":true,
    "can_see_other_account_swift_bic":true,
    "can_see_owner_comment":true,
    "can_see_physical_location":true,
    "can_see_private_alias":true,
    "can_see_public_alias":true,
    "can_see_tags":true,
    "can_see_transaction_amount":true,
    "can_see_transaction_balance":true,
    "can_see_transaction_currency":true,
    "can_see_transaction_description":true,
    "can_see_transaction_finish_date":true,
    "can_see_transaction_metadata":true,
    "can_see_transaction_other_bank_account":true,
    "can_see_transaction_start_date":true,
    "can_see_transaction_this_bank_account":true,
    "can_see_transaction_type":true,
    "can_see_url":true,
    "can_see_where_tag":true
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-50000: Unknown Error.
wrong format JSON
could not save the privilege
user does not have access to owner view on account

Implmented in 1_2_1 by addPermissionForUserForBankAccountForMultipleViews

Revoke access to all Views on Account

Revokes the user identified by PROVIDER_ID at their provider PROVIDER access to all the views at BANK_ID for account ACCOUNT_ID.

Authentication is Mandatory and the user needs to have access to the owner view.

Typical Successful Response:

								
									{
  "jsonString":"{}"
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-50000: Unknown Error.
user does not have access to owner view on account

Implmented in 1_2_1 by removePermissionForUserForBankAccountForAllViews

Revoke access to one View.

Revokes the user identified by PROVIDER_ID at their provider PROVIDER access to the view VIEW_ID at BANK_ID for account ACCOUNT_ID.

Revoking a user access to a public view will return an error message.

Authentication is Mandatory and the user needs to have access to the owner view.

Typical Successful Response:

								
									{
  "jsonString":"{}"
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
could not save the privilege
user does not have access to owner view on account
OBP-50000: Unknown Error.

Implmented in 1_2_1 by removePermissionForUserForBankAccountForOneView

Update View.

Update an existing view on a bank account

Authentication is Mandatory and the user needs to have access to the owner view.

The json sent is the same as during view creation (above), with one difference: the 'name' field of a view is not editable (it is only set when a view is created)

Typical Successful Response:

								
									{
  "id":"1234",
  "short_name":"short_name",
  "description":"description",
  "metadata_view":"owner",
  "is_public":true,
  "alias":"No",
  "hide_metadata_if_alias_used":true,
  "can_add_comment":true,
  "can_add_corporate_location":true,
  "can_add_image":true,
  "can_add_image_url":true,
  "can_add_more_info":true,
  "can_add_open_corporates_url":true,
  "can_add_physical_location":true,
  "can_add_private_alias":true,
  "can_add_public_alias":true,
  "can_add_tag":true,
  "can_add_url":true,
  "can_add_where_tag":true,
  "can_delete_comment":true,
  "can_add_counterparty":true,
  "can_delete_corporate_location":true,
  "can_delete_image":true,
  "can_delete_physical_location":true,
  "can_delete_tag":true,
  "can_delete_where_tag":true,
  "can_edit_owner_comment":true,
  "can_see_bank_account_balance":true,
  "can_query_available_funds":true,
  "can_see_bank_account_bank_name":true,
  "can_see_bank_account_currency":true,
  "can_see_bank_account_iban":true,
  "can_see_bank_account_label":true,
  "can_see_bank_account_national_identifier":true,
  "can_see_bank_account_number":true,
  "can_see_bank_account_owners":true,
  "can_see_bank_account_swift_bic":true,
  "can_see_bank_account_type":true,
  "can_see_comments":true,
  "can_see_corporate_location":true,
  "can_see_image_url":true,
  "can_see_images":true,
  "can_see_more_info":true,
  "can_see_open_corporates_url":true,
  "can_see_other_account_bank_name":true,
  "can_see_other_account_iban":true,
  "can_see_other_account_kind":true,
  "can_see_other_account_metadata":true,
  "can_see_other_account_national_identifier":true,
  "can_see_other_account_number":true,
  "can_see_other_account_swift_bic":true,
  "can_see_owner_comment":true,
  "can_see_physical_location":true,
  "can_see_private_alias":true,
  "can_see_public_alias":true,
  "can_see_tags":true,
  "can_see_transaction_amount":true,
  "can_see_transaction_balance":true,
  "can_see_transaction_currency":true,
  "can_see_transaction_description":true,
  "can_see_transaction_finish_date":true,
  "can_see_transaction_metadata":true,
  "can_see_transaction_other_bank_account":true,
  "can_see_transaction_start_date":true,
  "can_see_transaction_this_bank_account":true,
  "can_see_transaction_type":true,
  "can_see_url":true,
  "can_see_where_tag":true,
  "can_see_bank_routing_scheme":true,
  "can_see_bank_routing_address":true,
  "can_see_bank_account_routing_scheme":true,
  "can_see_bank_account_routing_address":true,
  "can_see_other_bank_routing_scheme":true,
  "can_see_other_bank_routing_address":true,
  "can_see_other_account_routing_scheme":true,
  "can_see_other_account_routing_address":true,
  "can_add_transaction_request_to_own_account":true,
  "can_add_transaction_request_to_any_account":true,
  "can_see_bank_account_credit_limit":true
}

Headers:

Required Roles:

Possible Errors:

OBP-10001: Incorrect json format.
OBP-20001: User not logged in. Authentication is required!
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-50000: Unknown Error.

Implmented in 3_0_0 by updateViewForBankAccount

Featured APIs

All OBP APIs

All OBP APIs v3.1.0 filtered by tag: Account (36)

Bank

Accounts

Views

Counterparties

Transactions

Check Available Funds

Create Account

Get Account by Id (Core)

Get Account by Id (Full)

Get Accounts Held

Get Accounts at Bank (IDs only).

Get Accounts at Bank (Minimal).

Get Accounts at Bank.

Get Accounts at all Banks (private)

Update Account Label.

Create Account Application

Get Account Application by Id

Get Account Applications

Update Account Application Status

Get Firehose Accounts at Bank

Get Firehose Customers

Get Firehose Transactions for Account

Get Public Account by Id

Get Public Accounts at Bank

Get Public Accounts at all Banks.

Create Counterparty (Explicit)

Get Counterparties (Explicit).

Get Other Account by Id.

Get Other Accounts of one Account.

Get Transactions for Account (Core)

Get Transactions for Account (Full)

Create View.

Delete View

Get Account access for User.

Get Views for Account.

Views

All

Get access.

Grant User access to View.

Grant User access to a list of views.

Revoke access to all Views on Account

Revoke access to one View.

Update View.