API Explorer
- API
- ATM
- Account
- Account Public
- Bank
- Branch
- Card
- Consumer
- 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
- Customer
- Customer Meeting
- Customer Message
- Data Warehouse
- Documentation
- FX
- KYC
- Metric
- Product
- Role
- Sandbox
- Transaction
- Transaction Metadata
- Transaction Request
- User
- View (Custom)
-
API
-
ATM
-
Account
-
Create Account
-
Create View
-
Get Account by Id (Core)
-
Get Account by Id (Full)
-
Get Accounts at Bank
-
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
-
Create Bank
-
Create Transaction Type at bank
-
Get Bank
-
Get Bank ATMS
-
Get Banks
-
Get Transaction Types at Bank
-
Create Bank
-
Branch
-
Card
-
Consumer
-
Counterparty
-
Create Counterparty (Explicit)
-
Get Counterparties (Explicit)
-
Get Counterparty by Counterparty Id (Explicit)
-
Get Other Account by Id
-
Get Other Accounts of one Account
-
Create Counterparty (Explicit)
-
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 Customers for current User at Bank
-
Add Social Media Handle
-
Customer Meeting
-
Customer Message
-
Data Warehouse
-
Documentation
-
FX
-
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
-
Product
-
Role
-
Add Entitlement for a User
-
Delete Entitlement
-
Get Entitlements for User
-
Get Entitlements for User at Bank
-
Get Roles
-
Get all Entitlements
-
Add Entitlement for a User
-
Sandbox
-
Transaction
-
Transaction Metadata
-
Add a tag
-
Add an image
-
Add comment
-
Add narrative
-
Add where tag
-
Delete a tag
-
Delete an image
-
Delete comment
-
Delete narrative
-
Delete where tag
-
Get comments
-
Get images
-
Get narrative
-
Get tags
-
Get where tag
-
Update narrative
-
Update where tag
-
Add a tag
-
Transaction Request
-
Answer Transaction Request Challenge
-
Create Transaction Request (COUNTERPARTY)
-
Create Transaction Request (FREE_FORM)
-
Create Transaction Request (SANDBOX_TAN)
-
Create Transaction Request (SEPA)
-
Get Transaction Request Types at Bank
-
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.2.0 (143 APIs)
Enable or Disable Consumers
Enable/Disable a Consumer specified by CONSUMER_ID.
Authentication is Mandatory
URL Parameters:
- CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
- enabled: true
{
"enabled":false
}
-
CanEnableConsumers
- Please login to request this Role
-
CanDisableConsumers
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Consumer
Get the Consumer specified by CONSUMER_ID.
Authentication is Mandatory
URL Parameters:
- CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
-
consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
enabled: true
-
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
-
username: felixsmith
{
"consumer_id":1213,
"app_name":"SOFI",
"app_type":"Web",
"description":"Account Management",
"developer_email":"felixsmith@example.com",
"redirect_url":"www.openbankproject.com",
"created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"created_by_user":{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email":"felixsmith@example.com",
"provider_id":"Chris",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
},
"enabled":true,
"created":"2017-09-19T00:00:00Z"
}
-
CanGetConsumers
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
- OBP-50000: Unknown Error.
Get Consumers
Get the all Consumers.
Authentication is Mandatory
JSON response body fields:
-
consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
enabled: true
-
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
-
username: felixsmith
{
"list":[{
"consumer_id":1213,
"app_name":"SOFI",
"app_type":"Web",
"description":"Account Management",
"developer_email":"felixsmith@example.com",
"redirect_url":"www.openbankproject.com",
"created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"created_by_user":{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email":"felixsmith@example.com",
"provider_id":"Chris",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
},
"enabled":true,
"created":"2017-09-19T00:00:00Z"
}]
}
-
CanGetConsumers
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Post a Consumer
Create a Consumer (Authenticated access).
Authentication is Mandatory
JSON request body fields:
-
clientCertificate: clientCertificate
-
enabled: true
JSON response body fields:
-
clientCertificate: clientCertificate
-
enabled: true
{
"app_name":"Some app name",
"app_type":"App type",
"description":"Description",
"developer_email":"some.email@example.com",
"redirect_url":"Some redirect url",
"created_by_user_id":"Created by UUID",
"enabled":true,
"created":"2022-06-14T07:58:38Z",
"clientCertificate":"-----BEGIN CERTIFICATE-----\nclient_certificate_content\n-----END CERTIFICATE-----"
}
-
CanCreateConsumer
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Update Consumer RedirectUrl
Update an existing redirectUrl for a Consumer specified by CONSUMER_ID.
CONSUMER_ID can be obtained after you register the application.
Or use the endpoint 'Get Consumers' to get it
Authentication is Mandatory
URL Parameters:
- CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
-
consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
enabled: true
-
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
-
username: felixsmith
{
"consumer_id":1213,
"app_name":"SOFI",
"app_type":"Web",
"description":"Account Management",
"developer_email":"felixsmith@example.com",
"redirect_url":"www.openbankproject.com",
"created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"created_by_user":{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email":"felixsmith@example.com",
"provider_id":"Chris",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith"
},
"enabled":true,
"created":"2017-09-19T00:00:00Z"
}
-
CanUpdateConsumerRedirectUrl
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.