API Explorer

Get JSON Web Key (JWK)

Get the server's public JSON Web Key (JWK) set and certificate chain.
It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.

Authentication is Optional

JSON response body fields:

Typical Successful Response:

								
									{
  "kty":"RSA",
  "e":"AQAB",
  "use":"sig",
  "kid":"fr6-BxXH5gikFeZ2O6rGk0LUmJpukeswASN_TMW8U_s",
  "n":"hrB0OWqg6AeNU3WCnhheG18R5EbQtdNYGOaSeylTjkj2lZr0_vkhNVYvase-CroxO4HOT06InxTYwLnmJiyv2cZxReuoVjTlk--olGu-9MZooiFiqWez0JzndyKxQ27OiAjFsMh0P04kaUXeHKhXRfiU7K2FqBshR1UlnWe7iHLkq2p9rrGjxQc7ff0w-Uc0f-8PWg36Y2Od7s65493iVQwnI13egqMaSvgB1s8_dgm08noEjhr8C5m1aKmr5oipWEPNi-SBV2VNuiCLR1IEPuXq0tOwwZfv31t34KPO-2H2bbaWmzGJy9mMOGqoNrbXyGiUZoyeHRELaNtm1GilyQ"
}

Headers:

Required Roles:

Possible Errors:

OBP-50000: Unknown Error.

Connector Methods:

obp.getBankAccountsForUser

Implemented in OBPv3.1.0 by getServerJWK, operation_id: OBPv3.1.0-getServerJWK

Check Available Funds

Check Available Funds
Mandatory URL parameters:

amount=NUMBER
currency=STRING

Authentication is Mandatory

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk
VIEW_ID: owner

JSON response body fields:

date: 2020-01-27

Typical Successful Response:

								
									{
  "answer":"yes",
  "date":"2023-01-26T06:25:45Z",
  "available_funds_request_id":"c4ykz59svsr9b7fmdxk8ezs7"
}

Headers:

Required Roles:

Possible Errors:

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

Connector Methods:

Implemented in OBPv3.1.0 by checkFundsAvailable, operation_id: OBPv3.1.0-checkFundsAvailable

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
Tags - A list of Tags assigned to this account

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

Authentication is Mandatory

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
BANK_ID: gh.29.uk

JSON response body fields:

amount: 10.12
balance: 10
bank_id: gh.29.uk
currency: EUR
label: My Account

Typical Successful Response:

								
									{
  "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "bank_id":"gh.29.uk",
  "label":"My Account",
  "number":"546387432",
  "product_code":"AC",
  "balance":{
    "currency":"EUR",
    "amount":"0"
  },
  "account_routings":[{
    "scheme":"AccountNumber",
    "address":"4930396"
  }],
  "views_basic":["owner"]
}

Headers:

Required Roles:

Possible Errors:

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

Connector Methods:

Implemented in OBPv4.0.0 by getCoreAccountById, operation_id: OBPv4.0.0-getCoreAccountById

Get Accounts Balances

Get the Balances for the Accounts of the current User at one bank.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
amount: 10.12
balances: balances
bank_id: gh.29.uk
currency: EUR
label: My Account

Typical Successful Response:

								
									{
  "accounts":[{
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "bank_id":"gh.29.uk",
    "account_routings":[{
      "scheme":"accountNumber",
      "address":"123456"
    }],
    "label":"My Account",
    "balances":[{
      "type":"",
      "currency":"EUR",
      "amount":"10"
    }]
  }]
}

Headers:

Required Roles:

Possible Errors:

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

Connector Methods:

Implemented in OBPv4.0.0 by getBankAccountsBalances, operation_id: OBPv4.0.0-getBankAccountsBalances

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.

optional request parameters:

account_type_filter: one or many accountType value, split by comma
account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE

whole url example:
/banks/BANK_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

bank_id: gh.29.uk
label: My Account

Typical Successful Response:

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

Headers:

Required Roles:

Possible Errors:

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

Connector Methods:

Implemented in OBPv3.0.0 by getAccountsHeld, operation_id: OBPv3.0.0-getAccountsHeld

Get Accounts at Bank (IDs only)

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

Each account must have at least one private View.

For each account the API returns its account ID.

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

optional request parameters:

account_type_filter: one or many accountType value, split by comma
account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE

whole url example:
/banks/BANK_ID/accounts/account_ids/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

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

Headers:

Required Roles:

Possible Errors:

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

Connector Methods:

Implemented in OBPv3.0.0 by getPrivateAccountIdsbyBankId, operation_id: OBPv3.0.0-getPrivateAccountIdsbyBankId

Get Accounts at Bank (Minimal)

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

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

optional request parameters:

account_type_filter: one or many accountType value, split by comma
account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE

whole url example:
/banks/BANK_ID/accounts/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

account_type: AC
bank_id: gh.29.uk
label: My Account

Typical Successful Response:

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

Headers:

Required Roles:

Possible Errors:

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

Connector Methods:

Implemented in OBPv3.0.0 by privateAccountsAtOneBank, operation_id: OBPv3.0.0-privateAccountsAtOneBank

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.

optional request parameters:

account_type_filter: one or many accountType value, split by comma
account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE

whole url example:
/my/accounts?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE

Authentication is Mandatory

JSON response body fields:

account_type: AC
bank_id: gh.29.uk
label: My Account

Typical Successful Response:

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

Headers:

Required Roles:

Possible Errors:

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

Connector Methods:

Implemented in OBPv3.0.0 by corePrivateAccountsAllBanks, operation_id: OBPv3.0.0-corePrivateAccountsAllBanks

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

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:

								
									{
  "id":"gh.29.uk",
  "short_name":"short_name ",
  "full_name":"full_name",
  "logo":"logo",
  "website":"www.openbankproject.com",
  "bank_routings":[{
    "scheme":"Bank_ID",
    "address":"gh.29.uk"
  }]
}

Headers:

Required Roles:

Possible Errors:

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.

Connector Methods:

obp.getBank

Implemented in OBPv3.0.0 by bankById, operation_id: OBPv3.0.0-bankById

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

Authentication is Optional

JSON response body fields:

Typical Successful Response:

								
									{
  "banks":[{
    "id":"gh.29.uk",
    "short_name":"short_name ",
    "full_name":"full_name",
    "logo":"logo",
    "website":"www.openbankproject.com",
    "bank_routings":[{
      "scheme":"Bank_ID",
      "address":"gh.29.uk"
    }]
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-50000: Unknown Error.

Connector Methods:

Implemented in OBPv4.0.0 by getBanks, operation_id: OBPv4.0.0-getBanks

Get Settlement accounts at Bank

Get settlement accounts on this API instance
Returns a list of settlement accounts at this Bank

Note: a settlement account is considered as a bank account.
So you can update it and add account attributes to it using the regular account endpoints

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
amount: 10.12
balance: 10
branch_id: DERBY6
currency: EUR
label: My Account
payment_system: SEPA
value: 5987953

Typical Successful Response:

								
									{
  "settlement_accounts":[{
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "payment_system":"SEPA",
    "balance":{
      "currency":"EUR",
      "amount":"0"
    },
    "label":"My Account",
    "branch_id":"DERBY6",
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "account_attributes":[{
      "product_code":"saving1",
      "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
      "name":"OVERDRAFT_START_DATE",
      "type":"DATE_WITH_DAY",
      "value":"2012-04-23"
    }]
  }]
}

Headers:

Required Roles:

CanGetSettlementAccountAtOneBank - Please login to request this Role

Possible Errors:

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

Connector Methods:

Implemented in OBPv4.0.0 by getSettlementAccounts, operation_id: OBPv4.0.0-getSettlementAccounts

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

amount: 10.12
bank_id: gh.29.uk
currency: EUR
value: 5987953

Typical Successful Response:

								
									{
  "transaction_types":[{
    "id":{
      "value":"123"
    },
    "bank_id":"gh.29.uk",
    "short_code":"PlaceholderString",
    "summary":"PlaceholderString",
    "description":"PlaceholderString",
    "charge":{
      "currency":"EUR",
      "amount":"0"
    }
  }]
}

Headers:

Required Roles:

Possible Errors:

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

Connector Methods:

Implemented in OBPv2.0.0 by getTransactionTypes, operation_id: OBPv2.0.0-getTransactionTypes

Answer Consent Challenge

An OBP Consent allows the holder of the Consent to call one or more endpoints.

Consents must be created and authorisied using SCA (Strong Customer Authentication).

That is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.

Each Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, REVOKED, RECEIVED, VALID, REVOKEDBYPSU, EXPIRED, TERMINATEDBYTPP, AUTHORISED, AWAITINGAUTHORISATION.

Each Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.
For example:
GET /obp/v4.0.0/users/current HTTP/1.1
Host: 127.0.0.1:8080
Consent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn
1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj
EtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml
zcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY
tNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg

Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk
cache-control: no-cache

Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.

Example of POST JSON:
{
"everything": false,
"views": [
{
"bank_id": "GENODEM1GLS",
"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"view_id": "owner"
}
],
"entitlements": [
{
"bank_id": "GENODEM1GLS",
"role_name": "CanGetCustomer"
}
],
"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"email": "eveline@example.com",
"valid_from": "2020-02-07T08:43:34Z",
"time_to_live": 3600
}
Please note that only optional fields are: consumer_id, valid_from and time_to_live.
In case you omit they the default values are used:
consumer_id = consumer of current user
valid_from = current time
time_to_live = consents.max_time_to_live

This endpoint is used to confirm a Consent previously created.

The User must supply a code that was sent out of band (OOB) for example via an SMS.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									{
  "consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945",
  "jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4",
  "status":"INITIATED"
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-10001: Incorrect json format.
OBP-50200: Connector cannot return the data we requested.
OBP-50000: Unknown Error.

Connector Methods:

Implemented in OBPv3.1.0 by answerConsentChallenge, operation_id: OBPv3.1.0-answerConsentChallenge

Create Consent (EMAIL)

This endpoint starts the process of creating a Consent.

The Consent is created in an INITIATED state.

A One Time Password (OTP) (AKA security challenge) is sent Out of band (OOB) to the User via the transport defined in SCA_METHOD
SCA_METHOD is typically "SMS" or "EMAIL". "EMAIL" is used for testing purposes.

When the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.