-
API
-
The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeablyMore...
- Get API Info (root)
-
-
Account
-
The thing that tokens of value (money) come in and out of. An account has one or more `owners` whichMore...
- Create Account
- Create View
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts at Bank
- Get Accounts at Bank (Private)
- Get Accounts at all Banks (Private)
- Get all Accounts at all Banks
- Get private accounts at one bank
- Update Account Label
- Update View
-
-
Bank
-
A Bank (aka Space) represents a financial institution, brand or organizational unit under which resMore...
- Get Bank
- Get Bank ATMS
- Get Bank Products
- Get Banks
- Get Transaction Types at Bank
-
-
Counterparty Metadata
- Add Corporate Location to Counterparty
- Add Counterparty More Info
- Add Open Corporates URL to Counterparty
- Add image url to other bank account
- Add physical location to other bank account
- Add public alias to other bank account
- Add url to other bank account
- Create Other Account Private Alias
- Delete Counterparty Corporate Location
- Delete Counterparty Image URL
- Delete Counterparty Open Corporates URL
- Delete Counterparty Physical Location
- Delete Counterparty Private Alias
- Delete Counterparty Public Alias
- Delete more info of other bank account
- Delete url of other bank account
- Get Other Account Metadata
- Get Other Account Private Alias
- Get public alias of other bank account
- Update Counterparty Corporate Location
- Update Counterparty Image Url
- Update Counterparty More Info
- Update Counterparty Physical Location
- Update Counterparty Private Alias
- Update Open Corporates Url of Counterparty
- Update public alias of other bank account
- Update url of other bank account
-
Customer
-
The legal entity that has the relationship to the bank. Customers are linked to Users via `User CusMore...
- Add Social Media Handle
- Create Customer
- Create User Customer Link
- Get CRM Events
- Get Customer Social Media Handles
- Get customer for logged in user
-
-
Transaction
-
Records of successful movements of money from / to an `Account`. OBP Transactions don't contain anyMore...
- Get Other Account of Transaction
- Get Transaction by Id
- Get Transactions for Account (Core)
- Get Transactions for Account (Full)
-
-
Transaction Metadata
- Add a Transaction Comment
- Add a Transaction Image
- Add a Transaction Narrative
- Add a Transaction Tag
- Add a Transaction where Tag
- Delete a Transaction Comment
- Delete a Transaction Image
- Delete a Transaction Narrative
- Delete a Transaction Tag
- Delete a Transaction Tag
- Get Transaction Comments
- Get Transaction Images
- Get Transaction Tags
- Get a Transaction Narrative
- Get a Transaction where Tag
- Update a Transaction Narrative
- Update a Transaction where Tag
-
User
-
The entity that accesses the API with a login / authorisation token and has access to zero or moreMore...
- Create User
- Get User (Current)
- Get Users by Email Address
-
-
API
-
Account
-
Create Account
-
Create View
-
Get Account by Id (Core)
-
Get Account by Id (Full)
-
Get Accounts at Bank
-
Get Accounts at Bank (Private)
-
Get Accounts at all Banks (Private)
-
Get all Accounts at all Banks
-
Get private accounts at one bank
-
Update Account Label
-
Update View
-
Create Account
-
Account Public
-
Bank
-
Branch
-
Card
-
Counterparty
-
Counterparty Metadata
-
Add Corporate Location to Counterparty
-
Add Counterparty More Info
-
Add Open Corporates URL to Counterparty
-
Add image url to other bank account
-
Add physical location to other bank account
-
Add public alias to other bank account
-
Add url to other bank account
-
Create Other Account Private Alias
-
Delete Counterparty Corporate Location
-
Delete Counterparty Image URL
-
Delete Counterparty Open Corporates URL
-
Delete Counterparty Physical Location
-
Delete Counterparty Private Alias
-
Delete Counterparty Public Alias
-
Delete more info of other bank account
-
Delete url of other bank account
-
Get Other Account Metadata
-
Get Other Account Private Alias
-
Get public alias of other bank account
-
Update Counterparty Corporate Location
-
Update Counterparty Image Url
-
Update Counterparty More Info
-
Update Counterparty Physical Location
-
Update Counterparty Private Alias
-
Update Open Corporates Url of Counterparty
-
Update public alias of other bank account
-
Update url of other bank account
-
Add Corporate Location to Counterparty
-
Customer
-
Add Social Media Handle
-
Create Customer
-
Create User Customer Link
-
Get CRM Events
-
Get Customer Social Media Handles
-
Get customer for logged in user
-
Add Social Media Handle
-
Customer Meeting
-
Customer Message
-
Data Warehouse
-
Documentation
-
KYC
-
Add KYC Check
-
Add KYC Document
-
Add KYC Media
-
Add KYC Status
-
Get Customer KYC Checks
-
Get Customer KYC Documents
-
Get Customer KYC statuses
-
Get KYC Media for a customer
-
Add KYC Check
-
Metric
-
Person
-
Role
-
Transaction
-
Get Other Account of Transaction
-
Get Transaction by Id
-
Get Transactions for Account (Core)
-
Get Transactions for Account (Full)
-
Get Other Account of Transaction
-
Transaction Metadata
-
Add a Transaction Comment
-
Add a Transaction Image
-
Add a Transaction Narrative
-
Add a Transaction Tag
-
Add a Transaction where Tag
-
Delete a Transaction Comment
-
Delete a Transaction Image
-
Delete a Transaction Narrative
-
Delete a Transaction Tag
-
Delete a Transaction Tag
-
Get Transaction Comments
-
Get Transaction Images
-
Get Transaction Tags
-
Get a Transaction Narrative
-
Get a Transaction where Tag
-
Update a Transaction Narrative
-
Update a Transaction where Tag
-
Add a Transaction Comment
-
Transaction Request
-
Answer Transaction Request Challenge
-
Create Transaction Request
-
Get Transaction Request Types for Account
-
Get Transaction Requests
-
Answer Transaction Request Challenge
-
User
-
View Custom
-
Delete View
-
Get Account access for User
-
Get Views for Account
-
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
-
Delete View
v2.0.0 (116 APIs)
API Host: https://api3.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions
Get all customers for logged in user
Information about the currently authenticated user.
Authentication via OAuth is required.
Authentication is Mandatory
JSON response body fields:
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
customer_number: 5987953
-
[date](/glossary#Scenario 6: Update credit score based on transaction and device data.): 2020-01-27
-
date_of_birth: 2018-03-09
-
employment_status: worker
-
highest_education_attained: Master
-
kyc_status: true
-
legal_name: Eveline Tripman
-
relationship_status: single
Typical Successful Response:
{
"customers":[{
"customer_id":"String",
"customer_number":"5987953",
"legal_name":"Eveline Tripman",
"mobile_phone_number":"+44 07972 444 876",
"email":"felixsmith@example.com",
"face_image":{
"url":"www.openbankproject",
"date":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z"
}]
}
Validations:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Possible Errors:
- OBP-20001: User not logged in. Authentication is required!
- OBP-30008: User Customer Link not found by USER_ID
- OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0,
function_name: by getCustomers, operation_id: OBPv2.0.0-getCustomers
Tags: Person, Customer,