Error processing snippet: WebUI.aboutBackground
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.aboutBackground><div id="main-about">
		<div class="row">
			<div class="col-xs-12 col-md-5"/>
			<div class="col-xs-12 col-md-7">
				<div id="main-about-box">
					<div data-lift="WebUI.aboutText" id="main-about-text">
						<h2>Welcome to the API Sandbox powered by the Open Bank Project!</h2>
						<p>This API, powered by the Open Bank Project, provides standard RESTful interfaces for developers to create customer facing and backend applications.<br/> </p>
					</div>
					<div id="main-about-buttons">
						<a class="btn btn-default" href="/consumer-registration">GET API KEY</a>
						<a href="" data-lift="WebUI.apiExplorerLink" class="api-explorer-link btn btn-default">API EXPLORER</a>
						<a href="" data-lift="WebUI.sofiLink" class="sofi-link btn btn-default">SOFIT</a>
						<a href="" data-lift="WebUI.sandboxIntroductionLink" class="btn btn-default" id="sandbox-introduction-link">INTRODUCTION</a>
					</div>
				</div>
			</div>
		</div>
	</div></lift:WebUI.aboutBackground>

note: this error is displayed in the browser because your application is running in "development" or "test" mode.If you set the system property run.mode=production, this error will not be displayed, but there will be errors in the output logs.

Get Started

Create an account

First, create a free developer account on this sandbox and request a developer key. You will be asked to submit basic information about your app at this stage. Register here.

Connect your app

Use our SDKs to connect your app to the Open Bank Project APIs. You will need your developer key, which was provided to you when you created an account. See all available APIs on the API Explorer. Please make sure you are using the correct base URL.

Test your app using customer data

Once your app is connected, you can test it using test customer credentials. You can find a list of sandbox customer logins

Error processing snippet: WebUI.exampleSandboxCredentialsLink
Reason: Class Not Found
XML causing this error:

<lift:WebUI.exampleSandboxCredentialsLink><a href="https://github.com/OpenBankProject/OBP-API/wiki/" class="example_sandbox_credentials_link">HERE</a></lift:WebUI.exampleSandboxCredentialsLink>

note: this error is displayed in the browser because your application is running in "development" or "test" mode.If you set the system property run.mode=production, this error will not be displayed, but there will be errors in the output logs.

Get your API key

Error processing snippet: WebUI.getStartedContentLoader
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.getStartedContentLoader><div id="get-started-script"/></lift:WebUI.getStartedContentLoader>

Your APIs

Error processing snippet: WebUI.apiExplorerLink
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.apiExplorerLink tags="Account,Card"><a href="" class="api-explorer-link">
				<div class="col-xs-12 col-sm-2 col-lg-1 main-apis-icon">
					<img alt="accounts" height="100" width="100" src="https://static.openbankproject.com/images/sandbox/icons/icon-accounts.png" class="icon-accounts"/>
				</div>
				<div class="col-xs-12 col-sm-4 col-lg-5 main-apis-text">
					<h2>Accounts</h2>
					<p>Access to accounts (XS2A) and cards. Provide fine-grained access to guests (auditor, accountant or public). Explore.. </p>
				</div>

			</a></lift:WebUI.apiExplorerLink>

Error processing snippet: WebUI.apiExplorerLink
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.apiExplorerLink tags="Bank,Bank-Branch,Bank-ATM,Bank-Product,Bank-FX"><a href="" class="api-explorer-link">
				<div class="col-xs-12 col-sm-2 col-lg-1 main-apis-icon">
					<img alt="branches" height="100" width="100" src="https://static.openbankproject.com/images/sandbox/icons/icon-branches.png" class="icon-entitlements"/>
				</div>
				<div class="col-xs-12 col-sm-4 col-lg-5 main-apis-text">
					<h2>Branches, ATMs and Products</h2>
					<p>Access open data related to banks including branches and ATMs including geolocation and opening hours. Explore..</p>
				</div>

			</a></lift:WebUI.apiExplorerLink>

Error processing snippet: WebUI.apiExplorerLink
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.apiExplorerLink tags="Transaction,Transaction-Metadata"><a href="" class="api-explorer-link">
				<div class="col-xs-12 col-sm-2 col-lg-1 main-apis-icon">
					<img alt="transactions" height="100" width="100" src="https://static.openbankproject.com/images/sandbox/icons/icon-transactions.png" class="icon-transactions"/>
				</div>
				<div class="col-xs-12 col-sm-4 col-lg-5 main-apis-text">
					<h2>Transactions</h2>
					<p>Access the transaction history and transaction metadata. Explore..</p>
				</div>
			</a></lift:WebUI.apiExplorerLink>

Error processing snippet: WebUI.apiExplorerLink
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.apiExplorerLink tags="Transaction-Metadata,Counterparty-Metadata"><a href="" class="api-explorer-link">
				<div class="col-xs-12 col-sm-2 col-lg-1 main-apis-icon">
					<img alt="metadata" height="100" width="100" src="https://static.openbankproject.com/images/sandbox/icons/icon-metadata.png" class="icon-metadata"/>
				</div>
				<div class="col-xs-12 col-sm-4 col-lg-5 main-apis-text">
					<h2>Metadata</h2>
					<p>Enrich transactions and counterparties with metadata including geolocations, comments, pictures and tags (e.g. category of spending). Explore..</p>
				</div>
			</a></lift:WebUI.apiExplorerLink>

Error processing snippet: WebUI.apiExplorerLink
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.apiExplorerLink tags="Counterparty,Counterparty-Metadata"><a href="" class="api-explorer-link">
				<div class="col-xs-12 col-sm-2 col-lg-1 main-apis-icon">
						<img alt="counterparties" height="100" width="100" src="https://static.openbankproject.com/images/sandbox/icons/icon-counterparties.png" class="icon-counterparties"/>
				</div>
				<div class="col-xs-12 col-sm-4 col-lg-5 main-apis-text">
					<h2>Counterparties</h2>
					<p>Access the payers &amp; payees of an account including metadata such as their aliases, labels, logos and home pages. Explore..</p>
				</div>
			</a></lift:WebUI.apiExplorerLink>

Error processing snippet: WebUI.apiExplorerLink
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.apiExplorerLink tags="Webhook"><a href="" class="api-explorer-link">
				<div class="col-xs-12 col-sm-2 col-lg-1 main-apis-icon">
					<img alt="entitlements" height="100" width="100" src="https://static.openbankproject.com/images/sandbox/icons/icon-entitlements.png" class="icon-branches"/>
				</div>
				<div class="col-xs-12 col-sm-4 col-lg-5 main-apis-text">
					<h2>Webhooks</h2>
					<p>Call external web servies based on Account events. Explore..</p>
				</div>
			</a></lift:WebUI.apiExplorerLink>

Error processing snippet: WebUI.apiExplorerLink
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.apiExplorerLink tags="Customer,KYC,Onboarding"><a href="" class="api-explorer-link">
				<div class="col-xs-12 col-sm-2 col-lg-1 main-apis-icon">
					<img alt="messages" height="100" width="100" src="https://static.openbankproject.com/images/sandbox/icons/icon-messages.png" class="icon-messages"/>
				</div>
				<div class="col-xs-12 col-sm-4 col-lg-5 main-apis-text">
					<h2>Customer onboarding and KYC</h2>
					<p>Perform user, customer and account creation. Manage Know Your Customer (KYC) documents, media and status. Create customer meetings and messages. Explore..</p>
				</div>
			</a></lift:WebUI.apiExplorerLink>

Error processing snippet: WebUI.apiExplorerLink
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.apiExplorerLink tags="API,API-Role,API-Metrics,API-Documentation"><a href="" class="api-explorer-link">
				<div class="col-xs-12 col-sm-2 col-lg-1 main-apis-icon">
					<img alt="security" height="100" width="100" src="https://static.openbankproject.com/images/sandbox/icons/icon-security.png" class="icon-security"/>
				</div>
				<div class="col-xs-12 col-sm-4 col-lg-5 main-apis-text">
					<h2>API Roles, Metrics and Documentation</h2>
					<p>Control access to endpoints, get API metrics and documentation. Explore..</p>
				</div>
			</a></lift:WebUI.apiExplorerLink>

Error processing snippet: WebUI.apiExplorerLink
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.apiExplorerLink tags="Transaction-Request"><a href="" class="api-explorer-link">
				<div class="col-xs-12 col-sm-2 col-lg-1 main-apis-icon">
					<img alt="requests" height="100" width="100" src="https://static.openbankproject.com/images/sandbox/icons/icon-requests.png" class="icon-requests"/>
				</div>
				<div class="col-xs-12 col-sm-4 col-lg-5 main-apis-text">
					<h2>Payments &amp; Transfers</h2>
					<p>Initiate Transaction Requests (transfers and payments). View and confirm charges (as per PSD2). Answer strong customer authentication (SCA) challenges. Explore..</p>
				</div>
			</a></lift:WebUI.apiExplorerLink>

Error processing snippet: WebUI.apiExplorerLink
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.apiExplorerLink tags="Data-Warehouse"><a href="" class="api-explorer-link">
				<div class="col-xs-12 col-sm-2 col-lg-1 main-apis-icon">
					<img alt="kyc" height="100" width="100" src="https://static.openbankproject.com/images/sandbox/icons/icon-kyc.png" class="icon-kyc"/>
				</div>
				<div class="col-xs-12 col-sm-4 col-lg-5 main-apis-text">
					<h2>Search warehouse</h2>
					<p>Perform advanced searches and statistics queries on the data warehouse. Explore..</p>
				</div>
			</a></lift:WebUI.apiExplorerLink>

Error processing snippet: WebUI.apiExplorerLink
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.apiExplorerLink><a href="" class="api-explorer-link">Go to API Explorer</a></lift:WebUI.apiExplorerLink>

SDK Showcases

Python

By OpenBankProject

Django

By OpenBankProject

NodeJS

By OpenBankProject

React

By OpenBankProject

Next.JS

By OpenBankProject

Flutter

By OpenBankProject

Mac

By OpenBankProject

IOS

By OpenBankProject

Java / Spring Boot

By OpenBankProject

Java / Android

By OpenBankProject

Scala / Liftweb

By OpenBankProject

PHP

By Solonas

C#

By Sweechem

Please make sure you are using the correct sandbox domain when using the SDKs. In doubt, drop us a line.

Technical FAQs

What is the correct base URL for this sandbox?

The base URL is

Error processing snippet: WebUI.apiLink
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.apiLink><a href="" class="api-link">http://apisandbox.openbankproject.com</a></lift:WebUI.apiLink>

Please make sure you are using this in all your API calls

I got a 404 error, what am I doing wrong

Avoid using trailing slashes, else, you would get a 404 error. Example:
.../obp/v1.4.0 200 OK
.../obp/v1.4.0/ 404 Not Found
Double check parameters are spelt correctly (including http vs https etc.)
Check your encoding (use UTF8)

How should I login?

There are two ways to authenticate a user: OAuth and Direct Login. If you are using this sandbox for a hackathon, we recommend you use Direct Login to authenticate as it is easier than the OAuth workflow.

How can I use OAuth or Direct Login?

If you want to use OBP with OAuth, we recommend you use (and fork) one of our OAuth Starter SDKs. If you are using this sandbox for a hackathon, we recommend you use

Error processing snippet: WebUI.directLoginDocumentationUrl
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.directLoginDocumentationUrl><a href="" class="direct-login-documentation-url">Direct Login</a></lift:WebUI.directLoginDocumentationUrl>

. For an OAuth walkthrough example with sample code, please see here. We use OAuth 1.0a. For deepish technical details of the flow

Error processing snippet: WebUI.oauth1DocumentationUrl
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.oauth1DocumentationUrl><a href="" class="oauth-1-documentation-url">see here.</a></lift:WebUI.oauth1DocumentationUrl>

We also support OAuth 2.0. For the technical details of using OBP API with OAuth 2.0, please

Error processing snippet: WebUI.oauth2DocumentationUrl
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.oauth2DocumentationUrl><a href="" class="oauth-2-documentation-url">see here.</a></lift:WebUI.oauth2DocumentationUrl>

Where can I read the API documentation?

Please use the

Error processing snippet: WebUI.apiExplorerLink
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.apiExplorerLink><a href="" class="api-explorer-link">API Explorer</a></lift:WebUI.apiExplorerLink>

How can I use the example customer data?

You will need to login to the API as a sandbox customer. You can do this using the API Explorer, or any REST client. You can find some example credentials

Error processing snippet: WebUI.exampleSandboxCredentialsLink
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.exampleSandboxCredentialsLink><a href="https://github.com/OpenBankProject/OBP-API/wiki/" class="example_sandbox_credentials_link">here</a></lift:WebUI.exampleSandboxCredentialsLink>

Where does the data come from?

Error processing snippet: WebUI.faqDataText
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.faqDataText><p class="collapse faq-data-text" id="main-faq-item6">Text is replaced</p></lift:WebUI.faqDataText>

Where can i get more information and support?

Please refer to our

Error processing snippet: WebUI.faqLink
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.faqLink><a target="_blank" href="" class="faq-link">FAQ</a></lift:WebUI.faqLink>

Error processing snippet: WebUI.glossaryLink
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.glossaryLink><a target="_blank" href="" class="glossary-link">Glossary</a></lift:WebUI.glossaryLink>

, join our

Error processing snippet: WebUI.supportPlatformLink
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.supportPlatformLink><a target="_blank" href="" class="support-platform-link">Slack channels</a></lift:WebUI.supportPlatformLink>

or email us at

Error processing snippet: WebUI.faqEmail
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.faqEmail><a href="" class="faq-email">contact@openbankproject.com</a></lift:WebUI.faqEmail>

Error processing snippet: WebUI.getStartedText
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.getStartedText><h1 name="get-started">Get started building your application using this sandbox now</h1></lift:WebUI.getStartedText>

Get your API key

Error processing snippet: WebUI.createMainPartners
Reason: Class Not Found
XML causing this error:

          <div id="main-partners">
		<a href="">
			<img alt="" src=""/>
		</a>
	</div>

For technical support

Email us

contact@openbankproject.com

Twitter

@OpenBankProject

Chat

Error processing snippet: WebUI.supportPlatformLink
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.supportPlatformLink><a target="_blank" href="" class="support-platform-link">Slack channel</a></lift:WebUI.supportPlatformLink>

Error processing snippet: WebUI.vendorSupportContentLoader
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.vendorSupportContentLoader><div id="vendor-support-script"/></lift:WebUI.vendorSupportContentLoader>

Error processing snippet: WebUI.aboutVendorContentLoader
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.aboutVendorContentLoader><div id="about-vendor-script"/></lift:WebUI.aboutVendorContentLoader>

Error processing snippet: WebUI.forBanks
Reason: Class Not Found
XML causing this error:

          <lift:WebUI.forBanks><div name="for-banks" id="for-banks">
		<h1>For Banks</h1>
		<a href="" data-lift="WebUI.apiManagerLink" class="api-manager-link btn btn-default btn-for-banks">API Manager</a>
		<a href="" data-lift="WebUI.obpCliLink" class="obp-cli-link btn btn-default btn-for-banks">OBP CLI</a>
		<a href="" data-lift="WebUI.apiTesterLink" class="api-tester-link btn btn-default btn-for-banks">API Tester</a>
	</div></lift:WebUI.forBanks>