All OBP APIs
- API
- ATM
- Account
- Account Application
- Account Firehose
- 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
- Add Address to Customer
- Add Social Media Handle
- Add Tax Residence to Customer
- Create Customer.
- Create User Customer Link.
- Delete Customer Address
- Delete Tax Residence
- Delete User AuthContext
- Delete User's Auth Contexts
- Get CRM Events
- Get Customer Addresses
- Get Customer Social Media Handles
- Get Customer by CUSTOMER_ID
- Get Customer by CUSTOMER_NUMBER
- Get Customers for Current User
- Get Customers for current User at Bank
- Get Tax Residences of Customer
- Customer Meeting
- Customer Message
- Data Warehouse
- Documentation
- FX
- KYC
- Metric
- Product
-
Role
- Add Entitlement Request for current User.
- Add Entitlement for a User.
- Delete Entitlement
- Delete Entitlement Request
- Get Entitlement Requests for a User.
- Get Entitlement Requests for the current User.
- Get Entitlements for User
- Get Entitlements for User at Bank.
- Get Entitlements for the current User.
- Get Roles
- Get all Entitlement Requests
- Get all Entitlements
- Sandbox
- Scope
- Transaction
- Transaction Metadata
-
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 for Account
- Get Transaction Requests.
- Get supported Transaction Request Types
- User
- View
- Webhook
All OBP APIs v3.1.0 (205)
Bank
Accounts
Views
Counterparties
Transactions
Get API Configuration
Returns information about:
- The default bank_id
- Akka configuration
- Elastic Search configuration
- Cached functions
{
"akka":{
"ports":[{
"property":"default",
"value":"8080"
}],
"log_level":"Debug",
"remote_data_secret_matched":true
},
"elastic_search":{
"metrics":[{
"property":"String",
"value":"Mapper"
}],
"warehouse":[{
"property":"String",
"value":"ElasticSearch"
}]
},
"cache":[{
"function_name":"getBanks",
"ttl_in_seconds":5
}]
}
-
CanGetConfig
- 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 API Info (root)
Returns information about:
- API version
- Hosted by information
- Git Commit
{
"version":"String",
"version_status":"String",
"git_commit":"String",
"connector":"String",
"hosted_by":{
"organisation":"String",
"email":"String",
"phone":"String",
"organisation_website":"String"
}
}
- OBP-50000: Unknown Error.
- no connector set
Get Adapter Info
Get basic information about the Adapter listening on behalf of this bank.
Authentication is Mandatory
{
"name":"String",
"version":"String",
"git_commit":"String",
"date":"2013-01-21T23:08:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get Adapter Info (general)
Get basic information about the Adapter.
Authentication is Mandatory
{
"name":"String",
"version":"String",
"git_commit":"String",
"date":"2013-01-21T23:08:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get Connector Status (Loopback)
This endpoint makes a call to the Connector to check the backend transport (e.g. Kafka) is reachable.
Currently this is only implemented for Kafka based connectors.
For Kafka based connectors, this endpoint writes a message to Kafka and reads it again.
In the future, this endpoint may also return information about database connections etc.
Authentication is Mandatory
{
"connector_version":"kafka_vSept2018",
"git_commit":"f0acd4be14cdcb94be3433ec95c1ad65228812a0",
"duration_time":"10 ms"
}
- OBP-50000: Unknown Error.
Get Rate Limiting Info
Get information about the Rate Limiting setup on this OBP Instance such as:
Is rate limiting enabled and active? What backend is used to keep track of the API calls (e.g. REDIS).
Authentication is Mandatory
{
"enabled":true,
"technology":"REDIS",
"service_available":true,
"is_active":true
}
- OBP-50000: Unknown Error.
Refresh User.
The endpoint is used for updating the accounts, views, account holders for the user.
Authentication is Mandatory
{
"duration_time":"10 ms"
}
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Create ATM
Create ATM for the Bank.
Authentication is Mandatory
OBP-20006: User is missing one or more roles: CanCreateAtm OR CanCreateAtmAtAnyBank
{
"id":"atm-id-123",
"bank_id":"bank-id-123",
"name":"Atm by the Lake",
"address":{
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE"
},
"location":{
"latitude":11.45,
"longitude":11.45
},
"meta":{
"license":{
"id":"5",
"name":"TESOBE"
}
},
"monday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"tuesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"wednesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"thursday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"friday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"saturday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"sunday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"is_accessible":"true",
"located_at":"Full service store",
"more_info":"short walk to the lake from here",
"has_deposit_capability":"true"
}
-
CanCreateAtm
- Please login to request this Role
-
CanCreateAtmAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Bank ATM
Returns information about ATM for a single bank specified by BANK_ID and ATM_ID including:
- Address
- Geo Location
- License the data under this endpoint is released under
Authentication is Optional
{
"id":"atm-id-123",
"bank_id":"bank-id-123",
"name":"Atm by the Lake",
"address":{
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE"
},
"location":{
"latitude":11.45,
"longitude":11.45
},
"meta":{
"license":{
"id":"5",
"name":"TESOBE"
}
},
"monday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"tuesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"wednesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"thursday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"friday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"saturday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"sunday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"is_accessible":"true",
"located_at":"Full service store",
"more_info":"short walk to the lake from here",
"has_deposit_capability":"true"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30009: ATM not found. Please specify a valid value for ATM_ID.
- OBP-50000: Unknown Error.
Get Bank ATMS
Returns information about ATMs for a single bank specified by BANK_ID including:
- Address
- Geo Location
- License the data under this endpoint is released under
Pagination:
By default, 100 records are returned.
You can use the url query parameters limit and offset for pagination
Authentication is Optional
{
"id":"atm-id-123",
"bank_id":"bank-id-123",
"name":"Atm by the Lake",
"address":{
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE"
},
"location":{
"latitude":11.45,
"longitude":11.45
},
"meta":{
"license":{
"id":"5",
"name":"TESOBE"
}
},
"monday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"tuesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"wednesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"thursday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"friday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"saturday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"sunday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"is_accessible":"true",
"located_at":"Full service store",
"more_info":"short walk to the lake from here",
"has_deposit_capability":"true"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- No ATMs available. License may not be set.
- OBP-50000: Unknown Error.
Check Available Funds
Check Available Funds Possible custom URL parameters for pagination:
- amount=NUMBER
- currency=STRING
{
"answer":"yes",
"date":"2019-02-09T04:43:55Z",
"available_funds_request_id":"c4ykz59svsr9b7fmdxk8ezs7"
}
- 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.
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.
{
"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"
}
}
-
CanCreateAccount
- Please login to request this Role
- 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.
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
{
"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"
}]
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-50000: Unknown Error.
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
.
{
"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"
}]
}
- 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.
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
{
"accounts":[{
"id":"12314",
"bank_id":"123",
"number":"123",
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}]
}]
}
- OBP-50000: Unknown Error.
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
{
"accounts":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf"
}]
}
- 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.
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
{
"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
}]
}]
}
- 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.
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
{
"accounts":[{
"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"label":"NoneLabel",
"bank_id":"gh.29.uk",
"views_available":[{
"id":"1",
"short_name":"HHH",
"is_public":true
}]
}]
}
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-50000: Unknown Error.
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
{
"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
}]
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
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
{
"success":"Success"
}
- 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
Create Account Application
Create Account Application
Authentication is Mandatory
{
"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"
}
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Get Account Application by Id
Get the Account Application.
Authentication is Mandatory
{
"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"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Account Applications
Get the Account Applications.
Authentication is Mandatory
{
"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"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Update Account Application Status
Update an Account Application status
Authentication is Mandatory
{
"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"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
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
{
"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"
}]
}]
}
-
CanUseFirehoseAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
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
{
"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"
}
}
}
}]
}
-
CanUseFirehoseAtAnyBank
- Please login to request this Role
- 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.
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
{
"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"
}
}
}
}]
}
-
CanUseFirehoseAtAnyBank
- Please login to request this Role
- 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.
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
{
"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"
}]
}
- 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.
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
{
"accounts":[{
"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"label":"NoneLabel",
"bank_id":"gh.29.uk",
"views_available":[{
"id":"1",
"short_name":"HHH",
"is_public":true
}]
}]
}
- OBP-50000: Unknown Error.
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
{
"accounts":[{
"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"label":"NoneLabel",
"bank_id":"gh.29.uk",
"views_available":[{
"id":"1",
"short_name":"HHH",
"is_public":true
}]
}]
}
- OBP-20001: User not logged in. Authentication is required!
- Could not get accounts.
- OBP-50000: Unknown Error.
Create Bank
Create a new bank (Authenticated access). Authentication is Mandatory
{
"id":"gh.29.uk.x",
"full_name":"uk",
"short_name":"uk",
"logo_url":"https://static.openbankproject.com/images/sandbox/bank_x.png",
"website_url":"https://www.example.com",
"swift_bic":"IIIGGB22",
"national_identifier":"UK97ZZZ1234567890",
"bank_routing":{
"scheme":"BIC",
"address":"OKOYFIHH"
}
}
-
CanCreateBank
- Please login to request this Role
- OBP-10001: Incorrect json format.
- OBP-20001: User not logged in. Authentication is required!
- OBP-30210: Insufficient authorisation to Create Bank. You do not have the role CanCreateBank.
- OBP-50000: Unknown Error.
Create Credit Limit Order Request
Create credit limit order request
{
"execution_time":"String",
"execution_date":"String",
"token":"String",
"short_reference":"String"
}
- OBP-50000: Unknown Error.
Create Transaction Type at bank
Create Transaction Types for the bank specified by BANK_ID:
- id : Unique transaction type id across the API instance. SHOULD be a UUID. MUST be unique.
- bank_id : The bank that supports this TransactionType
- short_code : A short code (SHOULD have no-spaces) which MUST be unique across the bank. May be stored with Transactions to link here
- summary : A succinct summary
- description : A longer description
- charge : The charge to the customer for each one of these
Authentication is Mandatory
{
"id":{
"value":"123"
},
"bankId":{
"value":"gh.uk.9j"
},
"shortCode":"80080",
"summary":"SANSANDBOX_TAN",
"description":"This is the sandbox mode, charging litter money.",
"charge":{
"currency":"EUR",
"amount":"100"
}
}
-
CanCreateTransactionType
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-10001: Incorrect json format.
- OBP-40005: Insufficient authorisation to Create Transaction Type offered by the bank. The Request could not be created because you don't have access to CanCreateTransactionType.
- OBP-50000: Unknown Error.
Get Bank
Get the bank specified by BANK_ID Returns information about a single bank specified by BANK_ID including:
- Short and full name of bank
- Logo URL
- Website
{
"id":"gh.29.uk",
"short_name":"short_name ",
"full_name":"full_name",
"logo":"logo",
"website":"www.openbankproject.com",
"bank_routing":{
"scheme":"Bank_ID",
"address":"gh.29.uk"
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
Get Banks
Get banks on this API instance Returns a list of banks supported on this server:
- ID used as parameter in URLs
- Short and full name of bank
- Logo URL
- Website
{
"banks":[{
"id":"gh.29.uk",
"short_name":"short_name ",
"full_name":"full_name",
"logo":"logo",
"website":"www.openbankproject.com",
"bank_routing":{
"scheme":"Bank_ID",
"address":"gh.29.uk"
}
}]
}
- OBP-50000: Unknown Error.
Get Credit Limit Order Request By Request Id
Get Credit Limit Order Request By Request Id
{
"rank_amount_1":"String",
"nominal_interest_1":"String",
"rank_amount_2":"String",
"nominal_interest_2":"String"
}
- OBP-50000: Unknown Error.
Get Credit Limit Order Requests
Get Credit Limit Order Requests
{
"rank_amount_1":"String",
"nominal_interest_1":"String",
"rank_amount_2":"String",
"nominal_interest_2":"String"
}
- OBP-50000: Unknown Error.
Get Transaction Types at Bank
Get Transaction Types for the bank specified by BANK_ID:
Lists the possible Transaction Types available at the bank (as opposed to Transaction Request Types which are the possible ways Transactions can be created by this API Server).
- id : Unique transaction type id across the API instance. SHOULD be a UUID. MUST be unique.
- bank_id : The bank that supports this TransactionType
- short_code : A short code (SHOULD have no-spaces) which MUST be unique across the bank. May be stored with Transactions to link here
- summary : A succinct summary
- description : A longer description
- charge : The charge to the customer for each one of these
Authentication is Optional
{
"transaction_types":[{
"id":{
"value":"123"
},
"bank_id":"PlaceholderString",
"short_code":"PlaceholderString",
"summary":"PlaceholderString",
"description":"PlaceholderString",
"charge":{
"currency":"EUR",
"amount":"10"
}
}]
}
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-50000: Unknown Error.
Get status of Credit Card order
Get status of Credit Card orders Get all orders
{
"cards":[{
"card_type":"5",
"card_description":"good",
"use_type":"3"
}]
}
- 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-50212: Connector did not return the set of status of credit card.
- OBP-50000: Unknown Error.
get Checkbook orders
Get all checkbook orders
{
"account":{
"bank_id":"10",
"account_id":"xjfsafjj",
"account_type":"330",
"account_routings":[{
"scheme":"AccountNumber",
"address":"4930396"
}],
"branch_routings":[{
"scheme":"BranchNumber",
"address":"678"
}]
},
"orders":[{
"order":{
"order_id":"xjksajfkj",
"order_date":"07082013",
"number_of_checkbooks":"4",
"distribution_channel":"1201",
"status":"2",
"first_check_number":"5165276",
"shipping_code":"1"
}
}]
}
- 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-50211: Connector did not return the set of check book.
- OBP-50000: Unknown Error.
Create Branch
Create Branch for the Bank.
Authentication is Mandatory
OBP-20006: User is missing one or more roles: CanCreateBranch entitlements are required OR CanCreateBranchAtAnyBank
{
"id":"branch-id-123",
"bank_id":"bank-id-123",
"name":"Branch by the Lake",
"address":{
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"String",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE"
},
"location":{
"latitude":10.0,
"longitude":10.0
},
"meta":{
"license":{
"id":"PDDL",
"name":"Open Data Commons Public Domain Dedication and License "
}
},
"lobby":{
"monday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"tuesday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"wednesday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"thursday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"friday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"saturday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"sunday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}]
},
"drive_up":{
"monday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"tuesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"wednesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"thursday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"friday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"saturday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"sunday":{
"opening_time":"10:00",
"closing_time":"18:00"
}
},
"branch_routing":{
"scheme":"OBP",
"address":"123abc"
},
"is_accessible":"true",
"accessibleFeatures":"wheelchair, atm usuable by the visually impaired",
"branch_type":"Full service store",
"more_info":"short walk to the lake from here",
"phone_number":"+381631954907"
}
-
CanCreateBranch
- Please login to request this Role
-
CanCreateBranchAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30209: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.
- OBP-50000: Unknown Error.
Get Branch
Returns information about a single Branch specified by BANK_ID and BRANCH_ID including:
- Name
- Address
- Geo Location
- License the data under this endpoint is released under.
Authentication is Optional
{
"id":"branch-id-123",
"bank_id":"bank-id-123",
"name":"Branch by the Lake",
"address":{
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"String",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE"
},
"location":{
"latitude":10.0,
"longitude":10.0
},
"meta":{
"license":{
"id":"PDDL",
"name":"Open Data Commons Public Domain Dedication and License "
}
},
"lobby":{
"monday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"tuesday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"wednesday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"thursday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"friday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"saturday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"sunday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}]
},
"drive_up":{
"monday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"tuesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"wednesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"thursday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"friday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"saturday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"sunday":{
"opening_time":"10:00",
"closing_time":"18:00"
}
},
"branch_routing":{
"scheme":"OBP",
"address":"123abc"
},
"is_accessible":"true",
"accessibleFeatures":"wheelchair, atm usuable by the visually impaired",
"branch_type":"Full service store",
"more_info":"short walk to the lake from here",
"phone_number":"+381631954907"
}
- OBP-20001: User not logged in. Authentication is required!
- License may not be set. meta.license.id and eta.license.name can not be empty
- OBP-50000: Unknown Error.
Get Branches for a Bank
Returns information about branches for a single bank specified by BANK_ID including:
- Name
- Address
- Geo Location
- License the data under this endpoint is released under
- Structured opening hours
- Accessible flag
- Branch Type
- More Info
Pagination:
By default, 50 records are returned.
You can use the url query parameters limit and offset for pagination
Authentication is Optional
{
"branches":[{
"id":"branch-id-123",
"bank_id":"bank-id-123",
"name":"Branch by the Lake",
"address":{
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"String",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE"
},
"location":{
"latitude":10.0,
"longitude":10.0
},
"meta":{
"license":{
"id":"PDDL",
"name":"Open Data Commons Public Domain Dedication and License "
}
},
"lobby":{
"monday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"tuesday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"wednesday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"thursday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"friday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"saturday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}],
"sunday":[{
"opening_time":"10:00",
"closing_time":"18:00"
}]
},
"drive_up":{
"monday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"tuesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"wednesday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"thursday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"friday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"saturday":{
"opening_time":"10:00",
"closing_time":"18:00"
},
"sunday":{
"opening_time":"10:00",
"closing_time":"18:00"
}
},
"branch_routing":{
"scheme":"OBP",
"address":"123abc"
},
"is_accessible":"true",
"accessibleFeatures":"wheelchair, atm usuable by the visually impaired",
"branch_type":"Full service store",
"more_info":"short walk to the lake from here",
"phone_number":"+381631954907"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- No branches available. License may not be set.
- OBP-50000: Unknown Error.
Update Branch
Update an existing branch for a bank account (Authenticated access). Authentication is Mandatory
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"name":"String",
"address":{
"line_1":"Osloer Straße 16/17",
"line_2":"Wedding",
"line_3":"",
"city":"Berlin",
"state":"Berlin Brandenburg",
"postcode":"13359",
"country":"DE"
},
"location":{
"latitude":11.45,
"longitude":11.45
},
"lobby":{
"hours":"5"
},
"drive_up":{
"hours":"5"
},
"meta":{
"license":{
"id":"5",
"name":"TESOBE"
}
},
"branch_routing":{
"scheme":"BranchNumber",
"address":"678"
}
}
-
CanCreateBranch
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-10001: Incorrect json format.
- OBP-30209: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.
- OBP-50000: Unknown Error.
Create Card
Create Card at bank specified by BANK_ID .
Authentication is Mandatory
{
"bank_id":"gh.29.uk",
"bank_card_number":"String",
"name_on_card":"String",
"issue_number":"String",
"serial_number":"String",
"valid_from_date":"2017-09-19T00:00:00Z",
"expires_date":"2017-09-19T00:00:00Z",
"enabled":true,
"cancelled":true,
"on_hot_list":true,
"technology":"String",
"networks":["String"],
"allows":["String"],
"account":{
"id":"123",
"label":"OBP",
"views_available":[{
"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
}],
"bank_id":"gh.uk.db"
},
"replacement":{
"requested_date":"2017-09-19T00:00:00Z",
"reason_requested":"RENEW"
},
"pin_reset":[{
"requested_date":"2017-09-19T00:00:00Z",
"reason_requested":"FORGOT"
}],
"collected":"2017-09-19T00:00:00Z",
"posted":"2017-09-19T00:00:00Z"
}
-
CanCreateCardsForBank
- 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-10015: Allowed values are:
- OBP-50000: Unknown Error.
Get cards for the current user
Returns data about all the physical cards a user has been issued. These could be debit cards, credit cards, etc.
{
"cards":[{
"bank_id":"gh.29.uk",
"bank_card_number":"String",
"name_on_card":"String",
"issue_number":"String",
"serial_number":"String",
"valid_from_date":"2017-09-19T00:00:00Z",
"expires_date":"2017-09-19T00:00:00Z",
"enabled":true,
"cancelled":true,
"on_hot_list":true,
"technology":"String",
"networks":["String"],
"allows":["String"],
"account":{
"id":"123",
"label":"OBP",
"views_available":[{
"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
}],
"bank_id":"gh.uk.db"
},
"replacement":{
"requested_date":"2017-09-19T00:00:00Z",
"reason_requested":"RENEW"
},
"pin_reset":[{
"requested_date":"2017-09-19T00:00:00Z",
"reason_requested":"FORGOT"
}],
"collected":"2017-09-19T00:00:00Z",
"posted":"2017-09-19T00:00:00Z"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get cards for the specified bank
{
"cards":[{
"bank_id":"gh.29.uk",
"bank_card_number":"String",
"name_on_card":"String",
"issue_number":"String",
"serial_number":"String",
"valid_from_date":"2017-09-19T00:00:00Z",
"expires_date":"2017-09-19T00:00:00Z",
"enabled":true,
"cancelled":true,
"on_hot_list":true,
"technology":"String",
"networks":["String"],
"allows":["String"],
"account":{
"id":"123",
"label":"OBP",
"views_available":[{
"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
}],
"bank_id":"gh.uk.db"
},
"replacement":{
"requested_date":"2017-09-19T00:00:00Z",
"reason_requested":"RENEW"
},
"pin_reset":[{
"requested_date":"2017-09-19T00:00:00Z",
"reason_requested":"FORGOT"
}],
"collected":"2017-09-19T00:00:00Z",
"posted":"2017-09-19T00:00:00Z"
}]
}
- 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.
Enable or Disable Consumers
Enable/Disable a Consumer specified by CONSUMER_ID.
{
"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 Call Limits for a Consumer
Get Calls limits per Consumer. Authentication is Mandatory
{
"per_minute_call_limit":"-1",
"per_hour_call_limit":"-1",
"per_day_call_limit":"-1",
"per_week_call_limit":"-1",
"per_month_call_limit":"-1"
}
-
CanSetCallLimits
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
- OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
- OBP-20006: User is missing one or more roles:
- OBP-30023: Cannot update Consumer
- OBP-50000: Unknown Error.
Get Consumer
Get the Consumer specified by CONSUMER_ID.
{
"consumer_id":1213,
"app_name":"SOFI",
"app_type":"Web",
"description":"Account Management",
"developer_email":"contact@tesobe.com",
"redirect_url":"www.openbankproject.com",
"created_by_user_id":"123213",
"created_by_user":{
"user_id":"123",
"email":"contact@tesobe.com",
"provider_id":"obp",
"provider":"obp",
"username":"TESOBE"
},
"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.
{
"list":[{
"consumer_id":1213,
"app_name":"SOFI",
"app_type":"Web",
"description":"Account Management",
"developer_email":"contact@tesobe.com",
"redirect_url":"www.openbankproject.com",
"created_by_user_id":"123213",
"created_by_user":{
"user_id":"123",
"email":"contact@tesobe.com",
"provider_id":"obp",
"provider":"obp",
"username":"TESOBE"
},
"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.
Get Consumers (logged in User)
Get the Consumers for logged in User.
{
"consumers":[{
"consumer_id":"8e716299-4668-4efd-976a-67f57a9984ec",
"app_name":"SOFI",
"app_type":"Web",
"description":"Account Management",
"developer_email":"contact@tesobe.com",
"redirect_url":"www.openbankproject.com",
"created_by_user":{
"user_id":"123",
"email":"contact@tesobe.com",
"provider_id":"obp",
"provider":"obp",
"username":"TESOBE"
},
"enabled":true,
"created":"2017-09-19T00:00:00Z"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Set Calls Limit for a Consumer
Set the API call limits for a Consumer:
Per Minute Per Hour Per Week Per Month
Authentication is Mandatory
{
"per_minute_call_limit":"-1",
"per_hour_call_limit":"-1",
"per_day_call_limit":"-1",
"per_week_call_limit":"-1",
"per_month_call_limit":"-1"
}
-
CanSetCallLimits
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
- OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
- OBP-20006: User is missing one or more roles:
- OBP-30023: Cannot update Consumer
- 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
{
"consumer_id":1213,
"app_name":"SOFI",
"app_type":"Web",
"description":"Account Management",
"developer_email":"contact@tesobe.com",
"redirect_url":"www.openbankproject.com",
"created_by_user_id":"123213",
"created_by_user":{
"user_id":"123",
"email":"contact@tesobe.com",
"provider_id":"obp",
"provider":"obp",
"username":"TESOBE"
},
"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.
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
{
"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
}
}
- 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.
Get Counterparties (Explicit).
Get the Counterparties (Explicit) for the account / view.
Authentication is Mandatory
{
"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"
}]
}]
}
- 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.
Get Counterparty by Counterparty Id.(Explicit).
Information returned about the Counterparty specified by COUNTERPARTY_ID:
Authentication is Mandatory
{
"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
}
}
- 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.
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.
{
"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"
}
}
}
}
- 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.
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.
{
"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"
}
}
}
}]
}
- 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.
Add Corporate Location to Counterparty
Add the geolocation of the counterparty's registered address
{
"success":"Success"
}
- 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.
- the view does not allow metadata access
- the view does not allow adding a corporate location
- Coordinates not possible
- Corporate Location cannot be deleted
- OBP-50000: Unknown Error.
Add Counterparty More Info
Add a description of the counter party from the perpestive of the account e.g. My dentist.
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- OBP-30022: The current view does not have the permission:
- the view ownerdoes not allow adding more info
- More Info cannot be added
- OBP-50000: Unknown Error.
Add Open Corporates URL to Counterparty
Add open corporates url to other bank account.
{
"success":"Success"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow adding an open corporate url
- URL cannot be added
- OBP-50000: Unknown Error.
Add image url to other bank account.
Add a url that points to the logo of the counterparty
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow adding an image url
- URL cannot be added
- OBP-50000: Unknown Error.
Add physical location to other bank account.
Add geocoordinates of the counterparty's main location
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow adding a physical location
- Coordinates not possible
- Physical Location cannot be added
- OBP-50000: Unknown Error.
Add public alias to other bank account.
Creates the public alias for the other account OTHER_ACCOUNT_ID.
Authentication is Optional Authentication is required if the view is not public.
Note: Public aliases are automatically generated for new 'other accounts / counterparties', so this call should only be used if the public alias was deleted.
The VIEW_ID parameter should be a view the caller is permitted to access to and that has permission to create public aliases.
{
"success":"Success"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- the view does not allow metadata access
- the view does not allow adding a public alias
- Alias cannot be added
- public alias added
Add url to other bank account.
A url which represents the counterparty (home page url etc.)
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow adding a url
- URL cannot be added
- OBP-50000: Unknown Error.
Create Other Account Private Alias
Creates a private alias for the other account OTHER_ACCOUNT_ID.
Authentication is Optional Authentication is required if the view is not public.
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow adding a private alias
- Alias cannot be added
- OBP-50000: Unknown Error.
Delete Counterparty Corporate Location.
Delete corporate location of other bank account. Delete the geolocation of the counterparty's registered address
{
"jsonString":"{}"
}
- 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.
- the view does not allow metadata access
- Corporate Location cannot be deleted
- Delete not completed
- OBP-50000: Unknown Error.
Delete Counterparty Image URL
Delete image url of other bank account.
{
"jsonString":"{}"
}
- OBP-50000: Unknown Error.
Delete Counterparty Open Corporates URL
Delete open corporate url of other bank account.
{
"jsonString":"{}"
}
- 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.
- the view does not allow metadata access
- the view does not allow deleting an open corporate url
- URL cannot be deleted
- OBP-50000: Unknown Error.
Delete Counterparty Physical Location.
Delete physical location of other bank account.
{
"jsonString":"{}"
}
- 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-30022: The current view does not have the permission:
- Physical Location cannot be deleted
- Delete not completed
- OBP-50000: Unknown Error.
Delete Counterparty Private Alias
Deletes the private alias of the other account OTHER_ACCOUNT_ID.
Authentication is Optional Authentication is required if the view is not public.
{
"jsonString":"{}"
}
- 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.
- the view does not allow metadata access
- the view does not allow deleting the private alias
- Alias cannot be deleted
- OBP-50000: Unknown Error.
Delete Counterparty Public Alias
Deletes the public alias of the other account OTHER_ACCOUNT_ID.
Authentication is Optional Authentication is required if the view is not public.
{
"jsonString":"{}"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- the view does not allow metadata access
- the view does not allow deleting the public alias
- Alias cannot be deleted
- OBP-50000: Unknown Error.
Delete more info of other bank account.
{
"jsonString":"{}"
}
- 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.
- the view does not allow metadata access
- the view does not allow deleting more info
- More Info cannot be deleted
- OBP-50000: Unknown Error.
Delete url of other bank account.
{
"jsonString":"{}"
}
- 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.
- the view does not allow metadata access
- the view does not allow deleting a url
- URL cannot be deleted
- OBP-50000: Unknown Error.
Get Other Account Metadata.
Get metadata of one other account. Returns only the metadata about one other bank account (OTHER_ACCOUNT_ID) that had shared at least one transaction with ACCOUNT_ID at BANK_ID.
Authentication via OAuth is required if the view is not public.
{
"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"
}
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
- the view does not allow metadata access
Get Other Account Private Alias
Returns the private alias of the other account OTHER_ACCOUNT_ID.
Authentication is Optional Authentication is required if the view is not public.
{
"alias":"String"
}
- 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.
- the view does not allow metadata access
- the view does not allow private alias access
- OBP-50000: Unknown Error.
Get public alias of other bank account.
Returns the public alias of the other account OTHER_ACCOUNT_ID. Authentication is Optional Authentication is Mandatory if the view is not public.
{
"alias":"String"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-50000: Unknown Error.
- the view does not allow metadata access
- the view does not allow public alias access
Update Counterparty Corporate Location
Update the geolocation of the counterparty's registered address
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating a corporate location
- Coordinates not possible
- Corporate Location cannot be updated
- OBP-50000: Unknown Error.
Update Counterparty Image Url
Update the url that points to the logo of the counterparty
{
"success":"Success"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating an image url
- URL cannot be updated
- OBP-50000: Unknown Error.
Update Counterparty More Info
Update the more info description of the counter party from the perpestive of the account e.g. My dentist.
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating more info
- More Info cannot be updated
- OBP-50000: Unknown Error.
Update Counterparty Physical Location
Update geocoordinates of the counterparty's main location
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating a physical location
- Coordinates not possible
- Physical Location cannot be updated
- OBP-50000: Unknown Error.
Update Counterparty Private Alias
Updates the private alias of the counterparty (AKA other account) OTHER_ACCOUNT_ID.
Authentication is Optional Authentication is required if the view is not public.
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating the private alias
- Alias cannot be updated
- OBP-50000: Unknown Error.
Update Open Corporates Url of Counterparty
Update open corporate url of other bank account.
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- the view does not allow metadata access
- the view does not allow updating an open corporate url
- URL cannot be updated
- OBP-50000: Unknown Error.
Update public alias of other bank account.
Updates the public alias of the other account / counterparty OTHER_ACCOUNT_ID.
Authentication is Optional Authentication is required if the view is not public.
{
"success":"Success"
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-10001: Incorrect json format.
- OBP-20001: User not logged in. Authentication is required!
- the view does not allow metadata access
- the view does not allow updating the public alias
- Alias cannot be updated
- OBP-50000: Unknown Error.
Update url of other bank account.
A url which represents the counterparty (home page url etc.)
{
"success":"Success"
}
- 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-10001: Incorrect json format.
- OBP-30022: The current view does not have the permission:
- OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
- URL cannot be updated
- OBP-50000: Unknown Error.
Add Address to Customer
Add an Address to the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
{
"customer_address_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"customer_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE",
"status":"OK",
"insert_date":"2017-09-19T00:00:00Z"
}
- 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.
Add Social Media Handle
Add a social media handle for the customer specified by CUSTOMER_ID.
{
"success":"Success"
}
-
CanAddSocialMediaHandle
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- 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-20006: User is missing one or more roles:
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
Add Tax Residence to Customer
Add a Tax Residence to the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
{
"tax_residence":[{
"domain":"Enter some domain",
"tax_number":"Enter some number",
"tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"
}]
}
- 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.
Create Customer.
The Customer resource stores the customer number, legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc. Dates need to be in the format 2013-01-21T23:08:00Z
Authentication is Mandatory
{
"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"
}
-
CanCreateCustomer
- Please login to request this Role
-
CanCreateUserCustomerLink
- Please login to request this Role
-
CanCreateCustomerAtAnyBank
- Please login to request this Role
-
CanCreateUserCustomerLinkAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-10001: Incorrect json format.
- OBP-30006: Customer Number already exists. Please specify a different value for BANK_ID or CUSTOMER_NUMBER.
- OBP-20005: User not found. Please specify a valid value for USER_ID.
- OBP-30007: The User is already linked to a Customer at the bank specified by BANK_ID
- OBP-30024: Could not create Consumer
- OBP-50000: Unknown Error.
Create User Customer Link.
Link a User to a Customer
Authentication is Mandatory
CanCreateUserCustomerLink OR CanCreateUserCustomerLinkAtAnyBank entitlements are required.
{
"user_customer_link_id":"String",
"customer_id":"String",
"user_id":"String",
"date_inserted":"2017-09-19T00:00:00Z",
"is_active":true
}
-
CanCreateUserCustomerLink
- Please login to request this Role
-
CanCreateUserCustomerLinkAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- 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-10001: Incorrect json format.
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-20006: User is missing one or more roles:
- OBP-30007: The User is already linked to a Customer at the bank specified by BANK_ID
- OBP-30025: Could not create user_customer_links
- OBP-50000: Unknown Error.
Delete Customer Address
Delete an Address of the Customer specified by CUSTOMER_ADDRESS_ID.
Authentication is Mandatory
{
"jsonString":"{}"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Delete Tax Residence
Delete a Tax Residence of the Customer specified by TAX_RESIDENCE_ID.
Authentication is Mandatory
{
"jsonString":"{}"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Delete User AuthContext
Delete a User AuthContext of the User specified by USER_AUTH_CONTEXT_ID.
Authentication is Mandatory
{
"jsonString":"{}"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Delete User's Auth Contexts
Delete the Auth Contexts of a User specified by USER_ID.
Authentication is Mandatory
{
"jsonString":"{}"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get CRM Events
{
"crm_events":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"bank_id":"gh.29.uk",
"customer_name":"String",
"customer_number":"String",
"category":"String",
"detail":"String",
"channel":"String",
"scheduled_date":"2017-09-19T00:00:00Z",
"actual_date":"2017-09-19T00:00:00Z",
"result":"String"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- No CRM Events available.
- OBP-50000: Unknown Error.
Get Customer Addresses
Get the Addresses of the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
{
"addresses":[{
"customer_address_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"customer_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE",
"status":"OK",
"insert_date":"2017-09-19T00:00:00Z"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Customer Social Media Handles
Get social media handles for a customer specified by CUSTOMER_ID.
Authentication is Mandatory
{
"checks":[{
"customer_number":"PlaceholderString",
"type":"PlaceholderString",
"handle":"PlaceholderString",
"date_added":"2017-09-19T00:00:00Z",
"date_activated":"2017-09-19T00:00:00Z"
}]
}
-
CanGetSocialMediaHandles
- 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-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
Get Customer by CUSTOMER_ID
Gets the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
{
"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"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30008: User Customer Link not found by USER_ID
- OBP-50000: Unknown Error.
Get Customer by CUSTOMER_NUMBER
Gets the Customer specified by CUSTOMER_NUMBER.
Authentication is Mandatory
{
"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"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30008: User Customer Link not found by USER_ID
- OBP-50000: Unknown Error.
Get Customers for Current User
Gets all Customers that are linked to a User.
Authentication is Mandatory
{
"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":"19900101",
"relationship_status":"123",
"dependants":123,
"dob_of_dependants":["19900101"],
"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"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30008: User Customer Link not found by USER_ID
- OBP-50000: Unknown Error.
Get Customers for current User at Bank
Retuns a list of Customers at the Bank that are linked to the currently authenticated User.
Authentication is Mandatory
{
"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"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30008: User Customer Link not found by USER_ID
- OBP-30008: User Customer Link not found by USER_ID
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
Get Tax Residences of Customer
Get the Tax Residences of the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
{
"tax_residence":[{
"domain":"Enter some domain",
"tax_number":"Enter some number",
"tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Create Meeting (video conference/call)
Create Meeting: Initiate a video conference/call with the bank.
The Meetings resource contains meta data about video/other conference sessions, not the video/audio/chat itself.
The actual conferencing is handled by external providers. Currently OBP supports tokbox video conferences (WIP).
This is not a recomendation of tokbox per se.
provider_id determines the provider of the meeting / video chat service. MUST be url friendly (no spaces).
purpose_id explains the purpose of the chat. onboarding | mortgage | complaint etc. MUST be url friendly (no spaces).
Login is required.
This call is experimental. Currently staff_user_id is not set. Further calls will be needed to correctly set this.
{
"meeting_id":"String",
"provider_id":"String",
"purpose_id":"String",
"bank_id":"gh.29.uk",
"present":{
"staff_user_id":"String",
"customer_user_id":"String"
},
"keys":{
"session_id":"String",
"staff_token":"String",
"customer_token":"String"
},
"when":"2017-09-19T00:00:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30102: Meeting provider API Key is not configured.
- OBP-30103: Meeting provider Secret is not configured.
- 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-10001: Incorrect json format.
- OBP-30101: Meetings are not supported on this server.
- OBP-50000: Unknown Error.
Get Meeting
Get Meeting specified by BANK_ID / MEETING_ID Meetings contain meta data about, and are used to facilitate, video conferences / chats etc.
The actual conference/chats are handled by external services.
Login is required.
This call is experimental and will require further authorisation in the future.
{
"meeting_id":"String",
"provider_id":"String",
"purpose_id":"String",
"bank_id":"gh.29.uk",
"present":{
"staff_user_id":"String",
"customer_user_id":"String"
},
"keys":{
"session_id":"String",
"staff_token":"String",
"customer_token":"String"
},
"when":"2017-09-19T00:00:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30102: Meeting provider API Key is not configured.
- OBP-30103: Meeting provider Secret is not configured.
- OBP-30104: Meeting not found.
- OBP-30101: Meetings are not supported on this server.
- OBP-50000: Unknown Error.
Get Meetings
Meetings contain meta data about, and are used to facilitate, video conferences / chats etc.
The actual conference/chats are handled by external services.
Login is required.
This call is experimental and will require further authorisation in the future.
{
"meetings":[{
"meeting_id":"String",
"provider_id":"String",
"purpose_id":"String",
"bank_id":"gh.29.uk",
"present":{
"staff_user_id":"String",
"customer_user_id":"String"
},
"keys":{
"session_id":"String",
"staff_token":"String",
"customer_token":"String"
},
"when":"2017-09-19T00:00:00Z"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30102: Meeting provider API Key is not configured.
- OBP-30103: Meeting provider Secret is not configured.
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30101: Meetings are not supported on this server.
- OBP-50000: Unknown Error.
Add Customer Message.
Add a message for the customer specified by CUSTOMER_ID
{
"success":"Success"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get Customer Messages (current)
Get messages for the logged in customer Messages sent to the currently authenticated user.
Authentication via OAuth is required.
{
"messages":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"date":"2017-09-19T00:00:00Z",
"message":"String",
"from_department":"String",
"from_person":"String"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Data Warehouse Search
Search the data warehouse and get row level results.
Authentication is Mandatory
CanSearchWarehouse entitlement is required. You can request the Role below.
Elastic (search) is used in the background. See links below for syntax.
Examples of usage:
POST /search/warehouse/THE_INDEX_YOU_WANT_TO_USE
POST /search/warehouse/INDEX1,INDEX2
POST /search/warehouse/ALL
{ Any valid elasticsearch query DSL in the body }
{
"jsonString":"{}"
}
-
CanSearchWarehouse
- 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.
Data Warehouse Statistics
Search the data warehouse and get statistical aggregations over a warehouse field
Does a stats aggregation over some numeric field:
https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html
Authentication is Mandatory
CanSearchWarehouseStats Role is required. You can request this below.
Elastic (search) is used in the background. See links below for syntax.
Examples of usage:
POST /search/warehouse/statistics/INDEX/FIELD
POST /search/warehouse/statistics/ALL/FIELD
{ Any valid elasticsearch query DSL in the body }
{
"jsonString":"{}"
}
-
CanSearchWarehouseStatistics
- 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 API Glossary
Returns the glossary of the API
{
"glossary_items":[{
"title":"String",
"description":{
"markdown":"String",
"html":"String"
}
}]
}
- OBP-50000: Unknown Error.
Get Message Docs
These message docs provide example messages sent by OBP to the (Kafka) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes. Integrators can use these messages to build Adapters that provide core banking services to OBP.
Note: API Explorer provides a Message Docs page where these messages are displayed.
CONNECTOR
:kafka_vMar2017 , kafka_vJune2017, kafka_vSept2018 ...
{
"message_docs":[{
"process":"getAccounts",
"message_format":"KafkaV2017",
"outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts",
"inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts",
"description":"get Banks",
"example_outbound_message":{
"jsonString":"{}"
},
"example_inbound_message":{
"jsonString":"{}"
},
"outboundAvroSchema":{
"jsonString":"{}"
},
"inboundAvroSchema":{
"jsonString":"{}"
},
"adapter_implementation":{
"group":"CORE",
"suggested_order":3
}
}]
}
- OBP-50000: Unknown Error.
Get Resource Docs.
Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.
This is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.
This endpoint is used by OBP API Explorer to display and work with the API documentation.
Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)
API_VERSION is the version you want documentation about e.g. v3.0.0
You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank
You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics
For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.
- operation_id is concatenation of "v", version and function and should be unique (used for DOM element IDs etc. maybe used to link to source code)
- version references the version that the API call is defined in.
- function is the (scala) partial function that implements this endpoint. It is unique per version of the API.
- request_url is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the implemented version (the version where this endpoint was defined) e.g. /obp/v1.2.0/resource
- specified_url (recommended to use) is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the version specified in the call e.g. /obp/v3.1.0/resource. In OBP, endpoints are first made available at the request_url, but the same resource (function call) is often made available under later versions (specified_url). To access the latest version of all endpoints use the latest version available on your OBP instance e.g. /obp/v3.1.0 - To get the original version use the request_url. We recommend to use the specified_url since non semantic improvements are more likely to be applied to later implementations of the call.
- summary is a short description inline with the swagger terminology.
- description may contain html markup (generated from markdown on the server).
{
"jsonString":"{}"
}
- OBP-50000: Unknown Error.
Get Swagger documentation
Returns documentation about the RESTful resources on this server in Swagger format.
API_VERSION is the version you want documentation about e.g. v3.0.0
You may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank
(All endpoints are given one or more tags which for used in grouping)
You may filter this endpoint using the 'functions' url parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics
(Each endpoint is implemented in the OBP Scala code by a 'function')
See the Resource Doc endpoint for more information.
{
"jsonString":"{}"
}
- OBP-50000: Unknown Error.
Create Fx
Create or Update Fx for the Bank.
Authentication is Mandatory
OBP-20006: User is missing one or more roles: CanCreateFxRate OR CanCreateFxRateAtAnyBank
{
"bank_id":"bankid123",
"from_currency_code":"EUR",
"to_currency_code":"USD",
"conversion_value":1.0,
"inverse_conversion_value":1.0,
"effective_date":"2017-09-19T00:00:00Z"
}
-
CanCreateFxRate
- Please login to request this Role
-
CanCreateFxRateAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Current FxRate
Get the latest FXRate specified by BANK_ID, FROM_CURRENCY_CODE and TO_CURRENCY_CODE
{
"bank_id":"bankid434",
"from_currency_code":"EUR",
"to_currency_code":"GBP",
"conversion_value":1.001,
"inverse_conversion_value":0.998,
"effective_date":"2017-09-19T00:00:00Z"
}
- OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
- OBP-20001: User not logged in. Authentication is required!
- OBP-10004: ISO Currency code combination not supported for FX. Please modify the FROM_CURRENCY_CODE or TO_CURRENCY_CODE.
- OBP-50000: Unknown Error.
Add KYC Check
Add a KYC check for the customer specified by CUSTOMER_ID. KYC Checks store details of checks on a customer made by the KYC team, their comments and a satisfied status.
{
"bank_id":"PlaceholderString",
"customer_id":"PlaceholderString",
"id":"PlaceholderString",
"customer_number":"PlaceholderString",
"date":"2017-09-19T00:00:00Z",
"how":"PlaceholderString",
"staff_user_id":"PlaceholderString",
"staff_name":"PlaceholderString",
"satisfied":true,
"comments":"PlaceholderString"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- 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-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-00004: Server error: could not add message
- OBP-50000: Unknown Error.
Add KYC Document.
Add a KYC document for the customer specified by CUSTOMER_ID. KYC Documents contain the document type (e.g. passport), place of issue, expiry etc.
{
"bank_id":"PlaceholderString",
"customer_id":"PlaceholderString",
"id":"PlaceholderString",
"customer_number":"PlaceholderString",
"type":"PlaceholderString",
"number":"PlaceholderString",
"issue_date":"2017-09-19T00:00:00Z",
"issue_place":"PlaceholderString",
"expiry_date":"2017-09-19T00:00:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- 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-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- Server error: could not add KycDocument
- OBP-50000: Unknown Error.
Add KYC Media.
Add some KYC media for the customer specified by CUSTOMER_ID. KYC Media resources relate to KYC Documents and KYC Checks and contain media urls for scans of passports, utility bills etc.
{
"bank_id":"PlaceholderString",
"customer_id":"PlaceholderString",
"id":"PlaceholderString",
"customer_number":"PlaceholderString",
"type":"PlaceholderString",
"url":"PlaceholderString",
"date":"2017-09-19T00:00:00Z",
"relates_to_kyc_document_id":"PlaceholderString",
"relates_to_kyc_check_id":"PlaceholderString"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- 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-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-00004: Server error: could not add message
- OBP-50000: Unknown Error.
Add KYC Status
Add a kyc_status for the customer specified by CUSTOMER_ID. KYC Status is a timeline of the KYC status of the customer
{
"customer_id":"PlaceholderString",
"customer_number":"PlaceholderString",
"ok":true,
"date":"2017-09-19T00:00:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- 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-50000: Unknown Error.
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-00004: Server error: could not add message
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
Get Customer KYC Checks
Get KYC checks for the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
{
"checks":[{
"bank_id":"PlaceholderString",
"customer_id":"PlaceholderString",
"id":"PlaceholderString",
"customer_number":"PlaceholderString",
"date":"2017-09-19T00:00:00Z",
"how":"PlaceholderString",
"staff_user_id":"PlaceholderString",
"staff_name":"PlaceholderString",
"satisfied":true,
"comments":"PlaceholderString"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
Get Customer KYC Documents
Get KYC (know your customer) documents for a customer specified by CUSTOMER_ID Get a list of documents that affirm the identity of the customer Passport, driving licence etc. Authentication is Optional
{
"documents":[{
"bank_id":"PlaceholderString",
"customer_id":"PlaceholderString",
"id":"PlaceholderString",
"customer_number":"PlaceholderString",
"type":"PlaceholderString",
"number":"PlaceholderString",
"issue_date":"2017-09-19T00:00:00Z",
"issue_place":"PlaceholderString",
"expiry_date":"2017-09-19T00:00:00Z"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
Get Customer KYC statuses
Get the KYC statuses for a customer specified by CUSTOMER_ID over time.
Authentication is Mandatory
{
"statuses":[{
"customer_id":"PlaceholderString",
"customer_number":"PlaceholderString",
"ok":true,
"date":"2017-09-19T00:00:00Z"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
Get KYC Media for a customer
Get KYC media (scans, pictures, videos) that affirms the identity of the customer.
Authentication is Mandatory
{
"medias":[{
"bank_id":"PlaceholderString",
"customer_id":"PlaceholderString",
"id":"PlaceholderString",
"customer_number":"PlaceholderString",
"type":"PlaceholderString",
"url":"PlaceholderString",
"date":"2017-09-19T00:00:00Z",
"relates_to_kyc_document_id":"PlaceholderString",
"relates_to_kyc_check_id":"PlaceholderString"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
Get Aggregate Metrics
Returns aggregate metrics on api usage eg. total count, response time (in ms), etc.
Should be able to filter on the following fields
eg: /management/aggregate-metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&consumer_id=5 &user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount &implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions &verb=GET&anon=false&app_name=MapperPostman &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
1 from_date (defaults to the day before the current date): eg:from_date=2017-09-19T02:31:05.000Z
2 to_date (defaults to the current date) eg:to_date=2017-09-19T02:31:05.000Z
3 consumer_id (if null ignore)
4 user_id (if null ignore)
5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
6 url (if null ignore), note: can not contain '&'.
7 app_name (if null ignore)
8 implemented_by_partial_function (if null ignore),
9 implemented_in_version (if null ignore)
10 verb (if null ignore)
11 correlation_id (if null ignore)
12 duration (if null ignore) non digit chars will be silently omitted
13 exclude_app_names (if null ignore).eg: &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
14 exclude_url_patterns (if null ignore).you can design you own SQL NOT LIKE pattern. eg: &exclude_url_patterns=%management/metrics%,%management/aggregate-metrics%
15 exclude_implemented_by_partial_functions (if null ignore).eg: &exclude_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics
Authentication is Mandatory
{
"count":7076,
"average_response_time":65.21,
"minimum_response_time":1.0,
"maximum_response_time":9039.0
}
-
CanReadAggregateMetrics
- 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 Connector Metrics
Get the all metrics
require CanGetConnectorMetrics role
Filters Part 1.*filtering* (no wilde cards etc.) parameters to GET /management/connector/metrics
Should be able to filter on the following metrics fields
eg: /management/connector/metrics?from_date=2017-09-19&to_date=2017-09-19&limit=50&offset=2
1 from_date (defaults to one week before current date): eg:from_date=2017-09-19
2 to_date (defaults to current date) eg:to_date=2017-09-19
3 limit (for pagination: defaults to 1000) eg:limit=2000
4 offset (for pagination: zero index, defaults to 0) eg: offset=10
eg: /management/connector/metrics?from_date=2017-09-19&to_date=2017-09-19&limit=100&offset=300
Other filters:
5 connector_name (if null ignore)
6 function_name (if null ignore)
7 correlation_id (if null ignore)
{
"metrics":[{
"connector_name":"mapper",
"function_name":"getBanks",
"correlation_id":"12345",
"date":"2017-09-19T00:00:00Z",
"duration":1000
}]
}
-
CanGetConnectorMetrics
- Please login to request this Role
- OBP-10005: Invalid Date Format. Could not convert value to a Date.
- OBP-50000: Unknown Error.
Get Metrics
Get the all metrics
require CanReadMetrics role
Filters Part 1.*filtering* (no wilde cards etc.) parameters to GET /management/metrics
Should be able to filter on the following metrics fields
eg: /management/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=50&offset=2
1 from_date (defaults to one week before current date): eg:from_date=2017-09-19T02:31:05.000Z
2 to_date (defaults to current date) eg:to_date=2017-09-19T02:31:05.000Z
3 limit (for pagination: defaults to 50) eg:limit=200
4 offset (for pagination: zero index, defaults to 0) eg: offset=10
5 sort_by (defaults to date field) eg: sort_by=date possible values: "url", "date", "user_name", "app_name", "developer_email", "implemented_by_partial_function", "implemented_in_version", "consumer_id", "verb"
6 direction (defaults to date desc) eg: direction=desc
eg: /management/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=10000&offset=0&anon=false&app_name=TeatApp&implemented_in_version=v2.1.0&verb=POST&user_id=c7b6cb47-cb96-4441-8801-35b57456753a&user_name=susan.uk.29@example.com&consumer_id=78
Other filters:
7 consumer_id (if null ignore)
8 user_id (if null ignore)
9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
10 url (if null ignore), note: can not contain '&'.
11 app_name (if null ignore)
12 implemented_by_partial_function (if null ignore),
13 implemented_in_version (if null ignore)
14 verb (if null ignore)
15 correlation_id (if null ignore)
16 duration (if null ignore) non digit chars will be silently omitted
{
"metrics":[{
"user_id":"134",
"url":"www.openbankproject.com",
"date":"2017-09-19T00:00:00Z",
"user_name":"OBP",
"app_name":"SOFI",
"developer_email":"contact@tesobe.ocm",
"implemented_by_partial_function":"getBanks",
"implemented_in_version":"v210",
"consumer_id":"123",
"verb":"get",
"correlation_id":"v8ho6h5ivel3uq7a5zcnv0w1",
"duration":39
}]
}
-
CanReadMetrics
- 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 Top APIs
Get metrics abou the most popular APIs. e.g.: total count, response time (in ms), etc.
Should be able to filter on the following fields
eg: /management/metrics/top-apis?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&consumer_id=5 &user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount &implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions &verb=GET&anon=false&app_name=MapperPostman &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
1 from_date (defaults to the day before the current date): eg:from_date=2017-09-19T02:31:05.000Z
2 to_date (defaults to the current date) eg:to_date=2017-09-19T02:31:05.000Z
3 consumer_id (if null ignore)
4 user_id (if null ignore)
5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
6 url (if null ignore), note: can not contain '&'.
7 app_name (if null ignore)
8 implemented_by_partial_function (if null ignore),
9 implemented_in_version (if null ignore)
10 verb (if null ignore)
11 correlation_id (if null ignore)
12 duration (if null ignore) non digit chars will be silently omitted
13 exclude_app_names (if null ignore).eg: &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
14 exclude_url_patterns (if null ignore).you can design you own SQL NOT LIKE pattern. eg: &exclude_url_patterns=%management/metrics%,%management/aggregate-metrics%
15 exclude_implemented_by_partial_functions (if null ignore).eg: &exclude_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics
Authentication is Mandatory
{
"top_apis":[{
"count":7076,
"Implemented_by_partial_function":"getBanks",
"implemented_in_version":"v1.2.1"
}]
}
-
CanReadMetrics
- 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-10016: Incorrect filter Parameters in URL.
- OBP-30042: Could not get the top apis from database.
- OBP-50000: Unknown Error.
Get Top Consumers
Get metrics about the top consumers of the API usage e.g. total count, consumer_id and app_name.
Should be able to filter on the following fields
e.g.: /management/metrics/top-consumers?from_date=2017-09-19T02:31:05.000Z&to_date=2017-05-22T01:02:03.000Z&consumer_id=5 &user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount &implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions &verb=GET&anon=false&app_name=MapperPostman &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null &limit=100
1 from_date (defaults to the day before the current date): eg:from_date=2017-09-19T02:31:05.000Z
2 to_date (defaults to the current date) eg:to_date=2017-09-19T02:31:05.000Z
3 consumer_id (if null ignore)
4 user_id (if null ignore)
5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
6 url (if null ignore), note: can not contain '&'.
7 app_name (if null ignore)
8 implemented_by_partial_function (if null ignore),
9 implemented_in_version (if null ignore)
10 verb (if null ignore)
11 correlation_id (if null ignore)
12 duration (if null ignore) non digit chars will be silently omitted
13 exclude_app_names (if null ignore).eg: &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
14 exclude_url_patterns (if null ignore).you can design you own SQL NOT LIKE pattern. eg: &exclude_url_patterns=%management/metrics%,%management/aggregate-metrics%
15 exclude_implemented_by_partial_functions (if null ignore).eg: &exclude_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics
16 limit (for pagination: defaults to 50) eg:limit=200
Authentication is Mandatory
{
"top_consumers":[{
"count":7076,
"consumer_id":"12312312",
"app_name":"Api Explorer",
"developer_email":"tesobe@tesobe.com"
}]
}
-
CanReadMetrics
- 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-10016: Incorrect filter Parameters in URL.
- OBP-30045: Could not get the top consumers from database.
- OBP-50000: Unknown Error.
Search API Metrics via Elasticsearch.
Search the API calls made to this API instance via Elastic Search.
Login is required.
CanSearchMetrics entitlement is required to search metrics data.
parameters:
esType - elasticsearch type
simple query:
q - plain_text_query
df - default field to search
sort - field to sort on
size - number of hits returned, default 10
from - show hits starting from
json query:
source - JSON_query_(URL-escaped)
example usage:
/search/metrics/q=findThis
or:
/search/metrics/source={"query":{"query_string":{"query":"findThis"}}}
Note!!
The whole JSON query string MUST be URL-encoded:
- For { use %7B
- For } use %7D
- For : use %3A
- For " use %22
etc..
Only q, source and esType are passed to Elastic
Elastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html
Elastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html
{
"jsonString":"{}"
}
-
CanSearchMetrics
- 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.
Create Product
Create or Update Product for the Bank.
Authentication is Mandatory
OBP-20006: User is missing one or more roles: CanCreateProduct OR CanCreateProductAtAnyBank
{
"bank_id":"bankid123",
"code":"prod1",
"name":"product name",
"category":"category",
"family":"family",
"super_family":"super family",
"more_info_url":"www.example.com/prod1/more-info.html",
"details":"Details",
"description":"Description",
"meta":{
"license":{
"id":"5",
"name":"TESOBE"
}
}
}
-
CanCreateProduct
- Please login to request this Role
-
CanCreateProductAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Create Product Attribute
Create Product Attribute
Product Attributes are used to describe a financial Product with a list of typed key value pairs.
Each Product Attribute is linked to its Product by PRODUCT_CODE
Authentication is Mandatory
{
"bank_id":"123",
"product_code":"saving1",
"product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23"
}
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Delete Product Attribute
Delete Product Attribute
Product Attributes are used to describe a financial Product with a list of typed key value pairs.
Each Product Attribute is linked to its Product by PRODUCT_CODE
Delete a Product Attribute by its id.
Authentication is Mandatory
{
"jsonString":"{}"
}
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Bank Product
Returns information about the financial products offered by a bank specified by BANK_ID and PRODUCT_CODE including:
- Name
- Code
- Category
- Family
- Super Family
- More info URL
- Description
- Terms and Conditions
- License the data under this endpoint is released under Authentication is Optional
{
"bank_id":"bankid123",
"code":"prod1",
"name":"product name",
"category":"category",
"family":"family",
"super_family":"super family",
"more_info_url":"www.example.com/prod1/more-info.html",
"details":"Details",
"description":"Description",
"meta":{
"license":{
"id":"5",
"name":"TESOBE"
}
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.
- OBP-50000: Unknown Error.
Get Bank Products
Returns information about the financial products offered by a bank specified by BANK_ID including:
- Name
- Code
- Category
- Family
- Super Family
- More info URL
- Description
- Terms and Conditions
- License the data under this endpoint is released under Authentication is Optional
{
"products":[{
"bank_id":"bankid123",
"code":"prod1",
"name":"product name",
"category":"category",
"family":"family",
"super_family":"super family",
"more_info_url":"www.example.com/prod1/more-info.html",
"details":"Details",
"description":"Description",
"meta":{
"license":{
"id":"5",
"name":"TESOBE"
}
}
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.
- OBP-50000: Unknown Error.
Get Product Attribute
Get Product Attribute
Product Attributes are used to describe a financial Product with a list of typed key value pairs.
Each Product Attribute is linked to its Product by PRODUCT_CODE
Get one product attribute by its id.
Authentication is Mandatory
{
"bank_id":"123",
"product_code":"saving1",
"product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23"
}
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Update Product Attribute
Update Product Attribute.
Product Attributes are used to describe a financial Product with a list of typed key value pairs.
Each Product Attribute is linked to its Product by PRODUCT_CODE
Update one Product Attribute by its id.
Authentication is Mandatory
{
"bank_id":"123",
"product_code":"saving1",
"product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23"
}
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Add Entitlement Request for current User.
Create Entitlement Request.
Any logged in User can use this endpoint to request an Entitlement
Entitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)
For a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
For a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
Authentication is Mandatory
{
"entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"user":{
"user_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"email":"robert.x.0.gh@example.com",
"provider_id":"OBP",
"provider":"OBP",
"username":"robert.x.0.gh",
"entitlements":{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
},
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk",
"created":"2017-09-19T00:00:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20005: User not found. Please specify a valid value for USER_ID.
- OBP-10001: Incorrect json format.
- OBP-10007: Incorrect Role name:
- OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.
- OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.
- OBP-30214: Entitlement Request already exists for the user.
- OBP-30217: Entitlement Request cannot be added.
- OBP-50000: Unknown Error.
Add Entitlement for a User.
Create Entitlement. Grant Role to User.
Entitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)
For a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
For a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
Authentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file.
{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}
-
CanCreateEntitlementAtOneBank
- Please login to request this Role
-
CanCreateEntitlementAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20005: User not found. Please specify a valid value for USER_ID.
- OBP-10001: Incorrect json format.
- OBP-10007: Incorrect Role name:
- OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.
- OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.
- OBP-30216: Entitlement already exists for the user.
- OBP-50000: Unknown Error.
Delete Entitlement
Delete Entitlement specified by ENTITLEMENT_ID for an user specified by USER_ID
Authentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file.
{
"jsonString":"{}"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20050: Logged user is not super admin!
- OBP-30212: EntitlementId not found
- OBP-50000: Unknown Error.
Delete Entitlement Request
Delete the Entitlement Request specified by ENTITLEMENT_REQUEST_ID for a user specified by USER_ID
Authentication is Mandatory
{
"jsonString":"{}"
}
-
CanDeleteEntitlementRequestsAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20050: Logged user is not super admin!
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.
Get Entitlement Requests for a User.
Get Entitlement Requests for a User.
Authentication is Mandatory
{
"entitlement_requests":[{
"entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"user":{
"user_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"email":"robert.x.0.gh@example.com",
"provider_id":"OBP",
"provider":"OBP",
"username":"robert.x.0.gh",
"entitlements":{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
},
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk",
"created":"2017-09-19T00:00:00Z"
}]
}
-
CanGetEntitlementRequestsAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20050: Logged user is not super admin!
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.
Get Entitlement Requests for the current User.
Get Entitlement Requests for the current User.
Authentication is Mandatory
{
"entitlement_requests":[{
"entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"user":{
"user_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"email":"robert.x.0.gh@example.com",
"provider_id":"OBP",
"provider":"OBP",
"username":"robert.x.0.gh",
"entitlements":{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
},
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk",
"created":"2017-09-19T00:00:00Z"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20050: Logged user is not super admin!
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.
Get Entitlements for User
Authentication is Mandatory
{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
-
CanGetEntitlementsForAnyUserAtAnyBank
- 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 Entitlements for User at Bank.
Get Entitlements specified by BANK_ID and USER_ID
Authentication is Mandatory
{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
-
CanGetEntitlementsForAnyUserAtOneBank
- Please login to request this Role
-
CanGetEntitlementsForAnyUserAtAnyBank
- 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 Entitlements for the current User.
Get Entitlements for the current User.
Authentication is Mandatory
{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20050: Logged user is not super admin!
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.
Get Roles
Returns all available roles
Authentication is Mandatory
{
"roles":[{
"role":"eBranch",
"requires_bank_id":true
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get all Entitlement Requests
Get all Entitlement Requests
Authentication is Mandatory
{
"entitlement_requests":[{
"entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"user":{
"user_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"email":"robert.x.0.gh@example.com",
"provider_id":"OBP",
"provider":"OBP",
"username":"robert.x.0.gh",
"entitlements":{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
},
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk",
"created":"2017-09-19T00:00:00Z"
}]
}
-
CanGetEntitlementRequestsAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20050: Logged user is not super admin!
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.
Get all Entitlements
Login is required.
Possible filter on the role field:
eg: /entitlements?role=CanGetCustomer
{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20050: Logged user is not super admin!
- OBP-50000: Unknown Error.
Create sandbox
Import bulk data into the sandbox (Authenticated access).
This call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.
The user needs to have CanCreateSandbox entitlement.
Note: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.
An example of an import set of data (json) can be found here Authentication is Mandatory
{
"success":"Success"
}
-
CanCreateSandbox
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-00002: Data import is disabled for this API instance.
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Add Scope for a Consumer.
Create Scope. Grant Role to Consumer.
Scopes are used to grant System or Bank level roles to the Consumer (App). (For Account level privileges, see Views)
For a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
For a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
{
"scope_id":"88625da4-a671-435e-9d24-e5b6e5cc404f",
"role_name":"CanGetEntitlementsForAnyUserAtOneBank",
"bank_id":"gh.29.uk"
}
-
CanCreateScopeAtOneBank
- Please login to request this Role
-
CanCreateScopeAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20024: Consumer not found. Please specify a valid value for CONSUMER_ID.
- OBP-10001: Incorrect json format.
- OBP-10007: Incorrect Role name:
- OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.
- OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.
- OBP-30216: Entitlement already exists for the user.
- OBP-50000: Unknown Error.
Delete Consumer Scope
Delete Consumer Scope specified by SCOPE_ID for an consumer specified by CONSUMER_ID
Authentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file.
{
"jsonString":"{}"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20050: Logged user is not super admin!
- OBP-30212: EntitlementId not found
- OBP-50000: Unknown Error.
Get Scopes for Consumer
Get all the scopes for an consumer specified by CONSUMER_ID
Authentication is Mandatory
{
"list":[{
"scope_id":"88625da4-a671-435e-9d24-e5b6e5cc404f",
"role_name":"CanGetEntitlementsForAnyUserAtOneBank",
"bank_id":"gh.29.uk"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-20050: Logged user is not super admin!
- OBP-30212: EntitlementId not found
- OBP-50000: Unknown Error.
Get Other Account of Transaction
Get other account of a transaction. Returns details of the other party involved in the transaction, moderated by the view (VIEW_ID). Authentication via OAuth is required if the view is not public.
{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"holder":{
"name":"OBP",
"is_alias":true
},
"number":"123",
"kind":"3456",
"IBAN":"UK234DB",
"swift_bic":"UK12321DB",
"bank":{
"national_identifier":"OBP",
"name":"OBP"
},
"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"
}
}
}
}
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-50000: Unknown Error.
Get Transaction by Id.
Returns one transaction specified by TRANSACTION_ID of the account ACCOUNT_ID and moderated by the view (VIEW_ID).
Authentication is Optional Authentication is required if the view is not public.