Glossary Index

API Glossary

API.Access Control

Access Control is achieved via the following mechanisms in OBP:

  • APIs are enabled in Props. See the README.md

  • Consumers (Apps) are granted access to Roles and Views via Scopes (WIP)

See here for related endpoints and documentation.

  • Users are granted access to System or Bank Roles via Entitlements.

See here for related endpoints and documentation.

Users may request Entitlement Requests here

Entitlements and Entitlement Requests can be managed in the OBP API Manager.

  • Users are granted access to Customer Accounts, Transactions and Payments via Views.

See here for related endpoints and documentation.

User Views can be managed via the OBP Sofit Consent App.

OBP Access Control Image

API.correlation_id

Example value: 1flssoftxq0cr1nssr68u0mioj

Description: A string generated by OBP-API that MUST uniquely identify the API call received by OBP-API. Used for debugging and logging purposes. It is returned in header to the caller.

Account

The thing that tokens of value (money) come in and out of.
An account has one or more owners which are Users.
In the future, Customers may also be owners.
An account has a balance in a specified currency and zero or more transactions which are records of successful movements of money.

Account.account_id

An identifier for the account that MUST NOT leak the account number or other identifier nomrally used by the customer or bank staff.
It SHOULD be a UUID. It MUST be unique in combination with the BANK_ID. ACCOUNT_ID is used in many URLS so it should be considered public.
(We do NOT use account number in URLs since URLs are cached and logged all over the internet.)
In local / sandbox mode, ACCOUNT_ID is generated as a UUID and stored in the database.
In non sandbox modes (Kafka etc.), ACCOUNT_ID is mapped to core banking account numbers / identifiers at the South Side Adapter level.
ACCOUNT_ID is used to link Metadata and Views so it must be persistant and known to the North Side (OBP-API).

Example value: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

Account.account_routing_address

Example value: DE91 1000 0000 0123 4567 89

Description: An identifier that conforms to account_routing_scheme / accountRoutingScheme

Account.account_routing_scheme

Example value: IBAN

Description: The scheme that the account_routing_address / accountRoutingAddress is an example of.

Account.iban

Example value: DE91 1000 0000 0123 4567 89

Description: MUST uniquely identify the bank account globally.

Account.owner

Example value: SusanSmith

Description: A username that is the owner of the account.

Account.queryTagsExample

Example value: Card,Debit

Description: This field is only used for OBP to distinguish the debit accounts, card accounts ...

Adapter.Akka.Intro

Use Akka as an interface between OBP and your Core Banking System (CBS).

For an introduction to Akka see here

The OBP Akka interface allows integrators to write Java or Scala Adapters (any JVM language with Akka support)
respond to requests for data and services from OBP.

For the message definitions see here

Installation Prerequisites

  • You have OBP-API running.

  • Ideally you have API Explorer running (the application serving this page) but its not necessary - you could use any other REST client.

  • You might want to also run API Manager as it makes it easier to grant yourself roles, but its not necessary - you could use the API Explorer / any REST client instead.

Create a Customer User and an Admin User

  • Register a User who will use the API as a Customer.
  • Register another User that will use the API as an Admin. The Admin user will need some Roles. See here. You can bootstrap an Admin user by editing the Props file. See the README for that.

Add some authentication context to the Customer User

  • As the Admin User, use the Create Auth Context endpoint to add one or more attributes to the Customer User.
    For instance you could add the name/value pair CUSTOMER_NUMBER/889763 and this will be sent to the Adapter / CBS inside the AuthInfo object.

Now you should be able to use the Get Auth Contexts endpoint to see the data you added.

Write or Build an Adapter to respond to the following messages.

When getting started, we suggest that you implement the messages in the following order:

1) Core (Prerequisites) - Get Adapter, Get Banks, Get Bank

Now you should be able to use the Adapter Info endpoint

Now you should be able to use the Get Banks endpoint

Now you should be able to use the Get Bank endpoint

2) Get Customers by USER_ID

Now you should be able to use the Get Customers endpoint.

3) Get Accounts

The above messages should enable at least the following endpoints:

4) Get Account

The above message should enable at least the following endpoints:

5) Get Transactions

6) Manage Counterparties

7) Get Transaction Request Types

  • This is configured using OBP Props - No messages required

This glossary item is Work In Progress.

Adapter.Kafka.Intro

Use Kafka as an interface between OBP and your Core Banking System (CBS).

For an introduction to Kafka see here

Installation Prerequisites

  • You have OBP-API running and it is connected to a Kafka installation.
    You can check OBP -> Kafka connectivity using the "loopback" endpoint.

  • Ideally you have API Explorer running (the application serving this page) but its not necessary - you could use any other REST client.

  • You might want to also run API Manager as it makes it easier to grant yourself roles, but its not necessary - you could use the API Explorer / any REST client instead.

Create a Customer User and an Admin User

  • Register a User who will use the API as a Customer.
  • Register another User that will use the API as an Admin. The Admin user will need some Roles. See here. You can bootstrap an Admin user by editing the Props file. See the README for that.

Add some authentication context to the Customer User

  • As the Admin User, use the Create Auth Context endpoint to add one or more attributes to the Customer User.
    For instance you could add the name/value pair CUSTOMER_NUMBER/889763 and this will be sent to the Adapter / CBS inside the AuthInfo object.

Now you should be able to use the Get Auth Contexts endpoint to see the data you added.

Write or Build an Adapter to respond to the following messages.

When getting started, we suggest that you implement the messages in the following order:

1) Core (Prerequisites) - Get Adapter, Get Banks, Get Bank

Now you should be able to use the Adapter Info endpoint

Now you should be able to use the Get Banks endpoint

Now you should be able to use the Get Bank endpoint

2) Core (Authentications) -The step1 Apis are all anonymous access. If you need to link bank customer data to the obp user,
Then you need link OBP user with Bank user/customer using the Create User Auth Context. Also
check the description for this endpoint. Once you create the user-auth-context for one user, then these user-auth-context key value pair
can be propagated over connector message. Than the Adapter can use it to map OBP user and Bank user/customer.

Now you should be able to use the Refresh User endpoint

3) Customers for logged in User

Now you should be able to use the Get Customers endpoint.

4) Get Accounts

Now you should already be able to use the Get Accounts at Bank (IDs only). endpoint.

The above messages should enable at least the following endpoints:

5) Get Account

The above message should enable at least the following endpoints:

6) Get Transactions

7) Manage Counterparties

8) Get Transaction Request Types

  • This is configured using OBP Props - No messages required

9) Get Challenge Threshold (CBS)

10) Make Payment (used by Create Transaction Request)

11) Get Transaction Requests.

12) Generate Security Challenges (CBS)

13) Answer Security Challenges (Validate)

  • Optional / Internal OBP (No additional messages required)

14) Manage Counterparty Metadata

  • Internal OBP (No additional messages required)

15) Get Entitlements

  • Internal OBP (No additional messages required)

16) Manage Roles

  • Internal OBP (No additional messages required)

17) Manage Entitlements

  • Internal OBP (No additional messages required)

18) Manage Views

  • Internal OBP (No additional messages required)

19) Manage Transaction Metadata

  • Internal OBP (No additional messages required)

Adapter.Stored_Procedure.Intro

Use Stored_Procedure as an interface between OBP and your Core Banking System (CBS).

For an introduction to Stored Procedures see here

Installation Prerequisites

  • You have OBP-API running and it is connected to a stored procedure related database.
  • Ideally you have API Explorer running (the application serving this page) but its not necessary - you could use any other REST client.
  • You might want to also run API Manager as it makes it easier to grant yourself roles, but its not necessary - you could use the API Explorer / any REST client instead.

Adapter.authInfo

authInfo is a JSON object sent by the Connector to the Adapter so the Adapter and/or Core Banking System can
identify the User making the call.

The authInfo object contains several optional objects and fields.

Please see the Message Docs for your connector for the current JSON structure. The following serves as a guide:

  • userId is the user_id as generated by OBP
  • username can be chosen explicitly to match an existing customer number (not recommended)
  • linkedCustomers is a list of Customers the User is explicitly linked to. Use the Create User Customer Link endpoint to populate this data.
  • userAuthContexts may contain the customer number or other tokens in order to boot strap the User Customer Links
    or provide an alternative method of tagging the User with an authorisation context.
    Use the Create UserAuthContext endpoint to populate this data.
  • cbsToken is a token used by the CBS to identify the user's session. Either generated by the CBS or Gateway.
  • isFirst is a flag that indicates that OBP should refresh the user's list of accounts from the CBS (and flush / invalidate any User's cache)
  • correlationId just identifies the API call.
  • authViews are entitlements given by account holders to third party users e.g. Sam may grant her accountant Jill read only access to her business account. See the Create View endpoint

authinfo_annotated_1

Adapter.card_attribute_id

Example value: b4e0352a-9a0f-4bfa-b30b-9003aa467f50

Description: A string that MUST uniquely identify the card attribute on this OBP instance. It SHOULD be a UUID.

Adapter.card_attribute_name

Example value: OVERDRAFT_START_DATE

Description: The Card attribute name

Adapter.card_attribute_value

Example value: 2012-04-23

Description: The card attribute values

Adapter.card_id

Example value: 36f8a9e6-c2b1-407a-8bd0-421b7119307e

Description: A string that MUST uniquely identify the card on this OBP instance. It SHOULD be a UUID.

Adapter.card_number

Example value: 364435172576215

Description: The number of the physical card

Adapter.card_type

Example value: Credit

Description: The type of the physical card. eg: credit, debit ...

Adapter.cbsToken

Example value: FYIUYF6SUYFSD

Description: A token provided by the Gateway for use by the Core Banking System

Adapter.issue_number

Example value: 1

Description: The issue number of the physical card, eg 1,2,3,4 ....

Adapter.key

Example value: CustomerNumber

Description: This key should be used with Adapter.value together. They are a pair.

Adapter.limit

Example value: 100

Description: The limit in pagination

Adapter.name_on_card

Example value: SusanSmith

Description: The name on the physical card

Adapter.offset

Example value: 100

Description: The offset in pagination

Adapter.provider_id

Example value: Chris

Description: The provider id of the user which is equivalent to the username.

Adapter.serial_number

Example value: 1324234

Description: The serial number of the physical card, eg 1123.

Adapter.value

Example value: 5987953

Description: This key should be used with Adapter.key together. They are a pair.

Attribute.name

Example value: STATUS

Description: Transaction attribute name

Attribute.type

Example value: STRING

Description: Transaction attribute type.

Attribute.value

Example value: closed

Description: Transaction attribute value.

Authentication.provider

Example value: http://127.0.0.1:8080

Description: The Provider authenticating this User

Bank

The entity that represents the financial institution or bank within a financial group.
Open Bank Project is a multi-bank API. Each bank resource contains basic identifying information such as name, logo and website.

Bank.bank_id

An identifier that uniquely identifies the bank or financial institution on the OBP-API instance.

It is typically a human (developer) friendly string for ease of identification.

It SHOULD NOT contain spaces.

In sandbox mode it typically has the form: "financialinstitutuion.sequencennumber.region.language". e.g. "bnpp-irb.01.it.it"

For production, it's value could be the BIC of the institution.

Example value: gh.29.uk

Bank.bank_routing_address

Example value: GENODEM1GLS

Description: An identifier that conforms to bank_routing_scheme / bankRoutingScheme

Bank.bank_routing_scheme

Example value: BIC

Description: The scheme that the bank_routing_address / bankRoutingAddress is an example of.

Branch.branch_id

Example value: DERBY6

Description: Uniquely identifies the Branch in combination with the bankId.

Branch.branch_routing_address

Example value: DERBY6

Description: An address that conforms to branch_routing_scheme / branchRoutingScheme

Branch.branch_routing_scheme

Example value: BRANCH-CODE

Description: The scheme that the branch_routing_address / branchRoutingAddress is an example of.

ChallengeAnswer.challengeId

Example value: 123chaneid13-6d02-40e3-a129-0b2bf89de9f0

Description: MUST uniquely identify the challenge globally.

ChallengeAnswer.hashOfSuppliedAnswer

Example value: a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3

Description: Sha256 hash value of the ChallengeAnswer.challengeId

Connector

In OBP, we use the term "Connector" to mean the Scala/Java/Other JVM code in OBP that connects directly or indirectly to the systems of record i.e. the Core Banking Systems, Payment Systems and Databases.

Several Connectors are present in the OBP source code and all must implement the Connector interface
- but, except when using the Star Connector, only one of them is active at any one time.

The active connector is defined in the OBP Props file.

A "Direct Connector" is considered to be one that talks directly to the system of record or existing service layer.

i.e. API -> Connector -> CBS

An "Indirect Connector" is considered one which pairs with an Adapter which in turn talks to the system of record or service layer.

i.e. API -> Connector -> Adapter -> CBS

The advantage of a Direct connector is that its perhaps simpler. The disadvantage is that you have to code in a JVM language, understand a bit about OBP internals and a bit of Scala.

The advantage of the Indirect Connector is that you can write the Adapter in any language and the Connector and Adapter are decoupled (you just have to respect the Outbound / Inbound message format).

The default Connector in OBP is a Direct Connector called "mapped". It is called the "mapped" connector because it talks directly to the OBP database (Postgres, MySQL, Oracle, MSSQL etc.) via the Liftweb ORM which is called Mapper.

If you want to create your own (Direct) Connector you can fork any of the connectors within OBP.

There is a special Connector called the Star Connector which can use functions from all the normal connectors.

Using the Star Connector we can dynamically reroute function calls to different Connectors per function per bank_id.

The OBP API Manager has a GUI to manage this or you can use the OBP Method Routing APIs to set destinations for each function call.

Note: We generate the source code for individual connectors automatically.

Consent, or Account onboarding, is the process by which the account owner gives permission for their account(s) to be accessible to the API endpoints.

In OBP, the account, transaction and payment APIs are all guarded by Account Views - with one exception, the account holders endpoint which can be used to
bootstrap account on-boarding.

Note: the account holders endpoint is generally made available only to the Account Onboarding App, so if a View does not exist, no API access to the account is possible.

Consent or Account onboarding can be managed in one of two ways:

1) A backend system (CBS or other) is the system of record for User Consent, and OBP mirrors this.

In this case:

a) OBP requires the CBS or other backend system to return a list of accounts and permissions associated with a User.

b) At User login, OBP automatically creates one or more Views for that User based on the permissions supplied by the CBS.

2) OBP is the system of record for User Consent.

In this case:

a) OBP requires the CBS, Gateway or other system to provide just a basic list of accounts owned by the User.

b) The Onboarding App or Bank's Onboarding Page then authenticates the User and calls the Create View endpoint.

c) The account, transaction and payment API endpoints then work as moderated by the relevant View permissions.

d) The User can revoke access by calling the delete View endpoint.

In summary:

Prior to Views being created on an Account for a User, only the 'accounts held' endpoint will work for the account holder, and this endpoint only provides enough information
to identify the account so it can be selected and on-boarded into the API.

Once a View exists for an Account, a User can interact with the Account via the API based on permissions defined in the View.

Consumer

The "consumer" of the API, i.e. the web, mobile or serverside "App" that calls on the OBP API on behalf of the end user (or system).

Each Consumer has a consumer key and secrect which allows it to enter into secure communication with the API server.

Counterparty.counterpartyId

Example value: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

Description: The Counterparty ID used in URLs. This SHOULD NOT be a name of a Counterparty.

Counterparty.counterpartyName

Example value: John Smith Ltd.

Description: The name of a Counterparty. Ideally unique for an Account

Counterparty.isBeneficiary

Example value: true

Description: This is a boolean. True if the originAccount can send money to the Counterparty

Customer

The legal entity that has the relationship to the bank. Customers are linked to Users via User Customer Links. Customer attributes include Date of Birth, Customer Number etc.

Customer.Credit.rating

Example value:

Description: .

Customer.Credit.source

Example value:

Description: .

Customer.attributeAlias

Example value: STRING

Description: Customer attribute alias.

Customer.attributeId

Example value: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

Description: Customer attribute id

Customer.attributeName

Example value: SPECIAL_TAX_NUMBER

Description: Customer attribute name

Customer.attributeType

Example value: STRING

Description: Customer attribute type.

Customer.attributeValue

Example value: 123456789

Description: Customer attribute value.

Customer.consumerId

Example value: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

Description: A non human friendly string that identifies the consumer. It is the app which calls the apis

Customer.customerAttributeId

Example value: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

Description: A non human friendly string that identifies the customer attribute and is used in URLs.

Customer.customerAttributeName

Example value: SPECIAL_TAX_NUMBER

Description: The Customer Attribute name, eg: SPECIAL_TAX_NUMBER

Customer.customerAttributeType

Example value: STRING

Description: It can be STRING, INTEGER, DOUBLE, DATE_WITH_DAY

Customer.customerAttributeValue

Example value: 123456789

Description: The Customer Attribute value of the current attribute type, eg: 123456789.

Customer.customerId

Example value: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

Description: A non human friendly string that identifies the customer and is used in URLs. This SHOULD NOT be the customer number. The combination of customerId and bankId MUST be unique on an OBP instance. customerId SHOULD be unique on an OBP instance. Ideally customerId is a UUID. A mapping between customer number and customer id is kept in OBP.

Customer.customerNumber

Example value: 5987953

Description: The human friendly customer identifier that MUST uniquely identify the Customer at the Bank ID. Customer Number is NOT used in URLs.

Customer.customer_id

The identifier that MUST NOT leak the customer number or other identifier nomrally used by the customer or bank staff. It SHOULD be a UUID and MUST be unique in combination with BANK_ID.

Example value: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

Customer.dependents

Example value: 1

Description: the number of dependents

Customer.employmentStatus

Example value: worker

Description: employment status

Customer.highestEducationAttained

Example value: Master

Description: highest education attained

Customer.kycStatus

Example value: true

Description: This is boolean to indicate if the cusomter's KYC has been checked.

Customer.legalName

Example value: Eveline Tripman

Description: The legal name of the Customer.

Customer.mobileNumber

Example value: +44 07972 444 876

Description: The mobile number name of the Customer.

Customer.nameSuffix

Example value: Sr

Description: suffix of the name

Customer.relationshipStatus

Example value: single

Description: relationship status

Customer.title

Example value: Dr.

Description: title of the name

Data Model Overview

An overview of the Open Bank Project Data Model.

This diagram may help in understanding the Open Bank Project entities, capabilities and concepts. However, it is subject to change. If we change the data model, we release migration scripts.

obp-data-model-overview

Direct Login

Direct Login is a simple authentication process to be used at hackathons and trusted environments:

1) Get your App key

Sign up or login as a developer.

Register your App key HERE

Copy and paste the consumer key for step two below.

2) Authenticate

Using your favorite http client:

POST https://apisandbox.openbankproject.com/my/logins/direct

Body

Leave Empty!

Headers:

Content-Type:  application/json


Authorization: DirectLogin username="janeburel",
                password="the-password-of-jane",
                consumer_key="your-consumer-key-from-step-one"

Here is it all together:

POST https://apisandbox.openbankproject.com/my/logins/direct HTTP/1.1
Authorization: DirectLogin username="janeburel",   password="686876",  consumer_key="GET-YOUR-OWN-API-KEY-FROM-THE-OBP"
Content-Type: application/json
Host: 127.0.0.1:8080
Connection: close
User-Agent: Paw/2.3.3 (Macintosh; OS X/10.11.3) GCDHTTPRequest
Content-Length: 0

You should receive a token:

{"token":"a-long-token-string"}

3) Make authenticated API calls

In subsequent calls you can use the token received in step 2

e.g.

Action:

PUT https://apisandbox.openbankproject.com/obp/v2.0.0/banks/obp-bankx-n/accounts/my-new-account-id

Body:

{  "type":"CURRENT",  "balance":{    "currency":"USD",    "amount":"0"  }}

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token-from-step-2"

Here is another example:

PUT https://apisandbox.openbankproject.com/obp/v2.0.0/banks/enbd-egy--p3/accounts/newaccount1 HTTP/1.1
Authorization: DirectLogin token="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyIiOiIifQ.C8hJZNPDI59OOu78pYs4BWp0YY_21C6r4A9VbgfZLMA"
Content-Type: application/json
Cookie: JSESSIONID=7h1ssu6d7j151u08p37a6tsx1
Host: 127.0.0.1:8080
Connection: close
User-Agent: Paw/2.3.3 (Macintosh; OS X/10.11.3) GCDHTTPRequest
Content-Length: 60

{"type":"CURRENT","balance":{"currency":"USD","amount":"0"}}

More information

Parameter names and values are case sensitive.
The following parameters must be sent by the client to the server:

   username
     The name of the user to authenticate.

   password
     The password used to authenticate user. Alphanumeric string.

   consumer_key
     The application identifier. Generated on OBP side via
     https://apisandbox.openbankproject.com/consumer-registration endpoint.

Each parameter MUST NOT appear more than once per request.

Dummy Customer Logins

The following dummy Customer Logins may be used by developers testing their applications on this sandbox:

Customer Logins{"email":"robert.uk.29@example.com","password":"d9c663","user_name":"robert.uk.29@example.com"},{"email":"susan.uk.29@example.com","password":"2b78e8","user_name":"susan.uk.29@example.com"},{"email":"anil.uk.29@example.com","password":"588848","user_name":"anil.uk.29@example.com"},{"email":"ellie.uk.29@example.com","password":"a81594","user_name":"ellie.uk.29@example.com"},{"email":"robin.fr.29@example.com","password":"c42142","user_name":"robin.fr.29@example.com"},{"email":"suzanne.fr.29@example.com","password":"a4f9af","user_name":"suzanne.fr.29@example.com"},{"email":"nathan.fr.29@example.com","password":"bde179","user_name":"nathan.fr.29@example.com"},{"email":"elise.fr.29@example.com","password":"79a0cb","user_name":"elise.fr.29@example.com"},{"email":"roberto.it.29@example.com","password":"6a463a","user_name":"roberto.it.29@example.com"},{"email":"susanna.it.29@example.com","password":"57a19b","user_name":"susanna.it.29@example.com"},{"email":"alfio.it.29@example.com","password":"69e8d6","user_name":"alfio.it.29@example.com"},{"email":"elisa.it.29@example.com","password":"14adc9","user_name":"elisa.it.29@example.com"},{"email":"rob.us.29@example.com","password":"a50eda","user_name":"rob.us.29@example.com"},{"email":"sue.us.29@example.com","password":"e1788f","user_name":"sue.us.29@example.com"},{"email":"alf.us.29@example.com","password":"9122a1","user_name":"alf.us.29@example.com"},{"email":"emily.us.29@example.com","password":"4984b4","user_name":"emily.us.29@example.com"},{"email":"roby.tr.29@example.com","password":"7deb47","user_name":"roby.tr.29@example.com"},{"email":"suzan.tr.29@example.com","password":"5f68f1","user_name":"suzan.tr.29@example.com"},{"email":"asil.tr.29@example.com","password":"af2d2b","user_name":"asil.tr.29@example.com"},{"email":"ela.tr.29@example.com","password":"09cf2b","user_name":"ela.tr.29@example.com"},{"email":"robert.be.29@example.com","password":"00f680","user_name":"robert.be.29@example.com"},{"email":"susan.be.29@example.com","password":"f46941","user_name":"susan.be.29@example.com"},{"email":"anil.be.29@example.com","password":"9404f4","user_name":"anil.be.29@example.com"},{"email":"ellie.be.29@example.com","password":"58e2a9","user_name":"ellie.be.29@example.com"},{"email":"robert.de.29@example.com","password":"ab4a83","user_name":"robert.de.29@example.com"},{"email":"susan.de.29@example.com","password":"432da0","user_name":"susan.de.29@example.com"},{"email":"anil.de.29@example.com","password":"adfa28","user_name":"anil.de.29@example.com"},{"email":"ellie.de.29@example.com","password":"2efb1f","user_name":"ellie.de.29@example.com"},{"email":"jaakko.fi.29@example.com","password":"8132cf","user_name":"jaakko.fi.29@example.com"},{"email":"helmi.fi.29@example.com","password":"9f5cc8","user_name":"helmi.fi.29@example.com"},{"email":"timo.fi.29@example.com","password":"6addcd","user_name":"timo.fi.29@example.com"},{"email":"katja.fi.29@example.com","password":"ca0317","user_name":"katja.fi.29@example.com"}

https://apiexplorersandbox.openbankproject.com/glossary#Sandbox-Introduction#customer-logins

Gateway Login

Introduction

Note: Gateway Login is NOT enabled on this instance!

Gateway Login Authorisation is made by including a specific header (see step 3 below) in any OBP REST call.

Note: Gateway Login does not require an explicit POST like Direct Login to create the token.

The Gateway is responsible for creating a token which is trusted by OBP absolutely!

When OBP recieves a token via Gateway Login, OBP creates or gets a user based on the username supplied.

obp login via gateway and jwt

To use Gateway Login:

1) Configure OBP API to accept Gateway Login.

Set up properties in a props file

# -- Gateway login --------------------------------------
# Enable/Disable Gateway communication at all
# In case isn't defined default value is false
# allow_gateway_login=false
# Define comma separated list of allowed IP addresses
# gateway.host=127.0.0.1
# Define secret used to validate JWT token
# gateway.token_secret=secret
# -------------------------------------- Gateway login --

Please keep in mind that property gateway.token_secret is used to validate JWT token to check it is not changed or corrupted during transport.

2) Create / have access to a JWT

HEADER:ALGORITHM & TOKEN TYPE

{
  "alg": "HS256",
  "typ": "JWT"
}

PAYLOAD:DATA

{
  "username": "simonr",
  "is_first": true,
  "timestamp": "timestamp",
  "consumer_id": "123",
  "consumer_name": "Name of Consumer"
}

VERIFY SIGNATURE

HMACSHA256(
  base64UrlEncode(header) + "." +
  base64UrlEncode(payload),

) secret base64 encoded

Here is the above example token:

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.
AS8D76F7A89S87D6F7A9SD876FA789SD78F6A7S9D78F6AS79DF87A6S7D9F7A6S7D9F78A6SD798F78679D786S789D78F6A7S9D78F6AS79DF876A7S89DF786AS9D87F69AS7D6FN1bWVyIn0.
KEuvjv3dmwkOhQ3JJ6dIShK8CG_fd2REApOGn1TRmgU

3) Try a REST call using the header

Using your favorite http client:

GET https://apisandbox.openbankproject.com/obp/v3.0.0/users/current

Body

Leave Empty!

Headers:

   Authorization: GatewayLogin token="your-jwt-from-step-above"

Here is it all together:

GET https://apisandbox.openbankproject.com/obp/v3.0.0/users/current HTTP/1.1
Host: localhost:8080
User-Agent: curl/7.47.0
Accept: /
Authorization: GatewayLogin token="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.
AS8D76F7A89S87D6F7A9SD876FA789SD78F6A7S9D78F6AS79DF87A6S7D9F7A6S7D9F78A6SD798F78679D786S789D78F6A7S9D78F6AS79DF876A7S89DF786AS9D87F69AS7D6FN1bWVyIn0.
KEuvjv3dmwkOhQ3JJ6dIShK8CG_fd2REApOGn1TRmgU"

CURL example

curl -v -H 'Authorization: GatewayLogin token="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.
AS8D76F7A89S87D6F7A9SD876FA789SD78F6A7S9D78F6AS79DF87A6S7D9F7A6S7D9F78A6SD798F78679D786S789D78F6A7S9D78F6AS79DF876A7S89DF786AS9D87F69AS7D6FN1bWVyIn0.
KEuvjv3dmwkOhQ3JJ6dIShK8CG_fd2REApOGn1TRmgU" https://apisandbox.openbankproject.com/obp/v3.0.0/users/current

You should receive a response like:

{
  "user_id": "33fd104f-3e6f-4025-97cc-b76bbdc9148e",
  "email": "marko@tesobe.com",
  "provider_id": "marko.milic",
  "provider": "https://tesobe.openbankproject.com",
  "username": "marko.milic",
  "entitlements": {
    "list": []
  }
}

and custom response header i.e. OBP returns a new token in the custom response header called GatewayLogin (to the Gateway)

{
"username": "simonr",
"CBS_auth_token": "fapsoidfuipoi889w3ih", (Encrypted by OBP Adapter)
"timestamp": "timestamp",
"consumer_id": "123",
"consumer_name": "Name of Consumer"
}

GatewayLogin token="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.
AS8D76F7A89S87D6F7A9SD876FA789SD78F6A7S9D78F6AS79DF87A6S7D9F7A6S7D9F78A6SD798F78679D786S789D78F6A7S9D78F6AS79DF876A7S89DF786AS9D87F69AS7D6FN1bWVyIn0.
KEuvjv3dmwkOhQ3JJ6dIShK8CG_fd2REApOGn1TRmgU"

Under the hood

The file, GatewayLogin.scala handles the Gateway Login.

We:

-> Check if Props allow_gateway_login is true
  -> Check if GatewayLogin header exists
    -> Check if getRemoteIpAddress is OK
      -> Look for "token"
        -> If "is_first" is true -OR- CBS_auth_token is empty then, call CBS to get accounts

The CBS_auth_token (either the new one from CBS or existing one from previous token) is returned in the GatewayLogin custom response header.

More information

Parameter names and values are case sensitive.

Each parameter MUST NOT appear more than once per request.

KYC (Know Your Customer)

KYC is the process by which the Bank can be assured that the customer is who they say they are.

OBP provides a number of endpoints that KYC Apps can interact with in order to get and store relevant data and update the KYC status of a Customer.

For instance:

1) Use KYC documents to add information about passports, ID cards, driving licenses including:

  • customer_number
  • type (of document)
  • number (of document)
  • issue_date
  • issue_place
  • expiry_date

For more info see here.

2) Use KYC check to record a check of the customer via phone call, in person meeting or PEP database search.

KYC Checks store:

  • customer_number
  • date
  • how (FACE_TO_FACE_MEETING, PHONE_INTERVIEW, PEP_SEARCH)
  • staff_user_id (who recorded the record)
  • staff_name (who recorded the record)
  • satisfied (True/False)
  • comments

For more info see here.

3) Use KYC Media to add media (image or video etc.) related to:

A) the documents listed in KYC documents

B) media that identifies the user e.g. a video ident.

C) media that relates to a KYC check

KYC Media stores:

  • customer_number
  • type
  • url
  • date
  • relates_to_kyc_document_id
  • relates_to_kyc_check_id

For more information see here.

4) Use KYC status to update the KYC status of a customer following a meeting or using one of the above calls.

KYC status stores:

  • customer_number
  • ok (True/False)
  • date

For more information see here.

5) Use other Customer related endpoints shown here to check for known Addresses, contact details, Tax Residences etc.

OAuth 1.0a

The following steps will explain how to connect an instance of the Open Bank Project OAuth Server 1.0a. This authentication mechanism is necessary so a third party application can consume the Open Bank project API securely.

The following documentation is based on the OAuth 1.0a specification so if you need more details you can refer to it.

Before starting to interact with the API, third party applications needs to get OAuth keys (consumer key and secret key). You can register your application here to get those keys for interacting with real data. If you want to use the sandbox before handling real data, please register your application here

1) Obtain a request token

To start a sign in flow, the application must obtain a request token by sending a signed message to :

POST https://apisandbox.openbankproject.com/oauth/initiate
  • oauth_callback: an absolute URI back to which the server will redirect the resource owner (user) when Authorization step is completed. If the application is unable to receive callbacks the parameter value MUST be set to “oob” (case sensitive), to indicate an out-of-band configuration.

  • oauth_consumer_key : The identifier portion of the client credentials (consumer key) which is obtained after application registration.

  • oauth_nonce : A nonce is a random string, uniquely generated by the client to allow the server to verify that a request has never been made before. The nonce value MUST be unique across all requests with the same timestamp, application credentials, and token combinations.

  • oauth_signature : the result of signing the request. Explained in detail here.

  • oauth_signature_method : The name of the signature method that will be used by the application to sign the request, as defined in OAuth protocol. The Open Bank Project OAuth server support "SHA1" and "SHA256" so the parameter MUST be set to “HMAC-SHA1" or “HMAC-SHA256”

  • oauth_timestamp : The timestamp value MUST be a positive integer and is expressed in the number of seconds since January 1, 1970 00:00:00 GMT.

  • oauth_version : OPTIONAL. If present, MUST be set to "1.0". Provides the version of the authentication process as defined in the OAuth 1.0 protocol specification.

Example:

POST /oauth/initiate HTTP/1.1

Host: https://apisandbox.openbankproject.com

Authorization: OAuth

oauth_callback="http%3A%2F%2Fprinter.example.com%2Fready",

oauth_consumer_key="cChZNFj6T5R0TigYB9yd1w",

oauth_nonce="ea9ec8429b68d6b77cd5600adbbb0456",

oauth_signature="F1Li3tvehgcraF8DMJ7OyxO4w9Y%3D",

oauth_signature_method="HMAC-SHA256",

oauth_timestamp="1318467427",

oauth_version="1.0"

important: We will explain below in the "signature" section how to calculate the value of the "oauth_signature" field.

Note : line breaks are for display purposes only, the application MUST send the parameters on one line and the only separator between the parameters is a coma “,”.

The server validates the request and replies with a set of temporary credentials in the body of the HTTP response.

Example (line breaks are for display purposes only) :

HTTP/1.1 200 OK
Content-Type: application/x-www-form-urlencoded
oauth_token=hh5s93j4hdidpola&oauth_token_secret=hdhd0244k9j7ao03&oauth_callback_confirmed=true

The application should examine the HTTP status of the response. Any value other than 200 indicates a failure. The body of the response will contain the oauth_token, oauth_token_secret, and oauth_callback_confirmed parameters. The application should verify that oauth_callback_confirmed is true and store the other two values for the next steps.

2) Redirect the user

The next step is to direct the user to Open Bank Project so that he may complete the authentication.

Direct the user to :

GET oauth/authorize

and the request token obtained in step 1 should be passed as the oauth_token parameter.

The most seamless way for a website to implement this would be to issue a HTTP 302 redirect as the response to the original request. Mobile and desktop applications should open a new browser window or direct to the URL via an embedded web view.

Example :

https://apisandbox.openbankproject.com/oauth/authorize?oauth_token=NPcudxy0yU5T3tBzho7iCotZ3cnetKwcTIRlX0iwRl0

Upon a successful authentication, the callback URL would receive a request containing the oauth_token and oauth_verifier parameters. The application should verify that the token matches the request token received in step 1.

If the callback URL was not specified (oob) than the verifier will be shown in the page and the user has to enter it into the application manually.

3) Convert the request token to an access token

To convert the request token into a usable access token, the application must make a:

POST https://apisandbox.openbankproject.com/oauth/token

request containing the oauth_verifier value obtained in step 2. The request token is also passed as oauth_token parameter of the header.

Note : The oauth_callback_url parameter is not necessary any more.

Example :

POST /oauth/token HTTP/1.1

Host: https://apisandbox.openbankproject.com

Authorization: OAuth

oauth_verifier="9312832",

oauth_token=”aze2342352aze”,

oauth_consumer_key="cChZNFj6T5R0TigYB9yd1w",

oauth_nonce="ea9ec8429b68d6b77cd5600adbbb0456",

oauth_signature="F1Li3tvehgcraF8DMJ7OyxO4w9Y%3D",

oauth_signature_method="HMAC-SHA256",

oauth_timestamp="1318467427",

oauth_version="1.0"

Like the step 1, a successful response contains the oauth_token & oauth_token_secret and they should be stored and used for future authenticated requests to the OBP API.

The application can now use the access token to access protected resources.

4) Access protected resources

Once the application has an a access token and secret token, it can access protected resources. The request is the same as in step 3 except the oauth_verifer which MUST not be included in the header.

Please see the API documentation for more details on how to access protected resources.

Recommended OAuth 1.0 libraries:

If you want to use a OAuth library to handle the OAuth process for your application, we have successfully tested these ones:

  • JAVA:

signpost. Warning any version below 1.2.1.2 probably will not work. Version 1.2 which is the current Maven version seems to cause problems.

  • PHP:

OAuth Consumer And Server Library

  • Scala:

Dispatch

  • OBP SDKs / examples of client code with OAuth:

OBP SDKs

Examples :

To show the OAuth integration in concrete examples, please check out these projects listed here:
Hello-OBP-OAuth1.0a-LANGUAGE/PLATFORM

Signature :

According to the section-3.4 in the OAuth 1.0 protocol specification the signature computation is done following theses steps :

a) Signature Base String :

The signature base string is a consistent, reproducible concatenation of several of the HTTP request elements into a single string. The string is used as an input to the signature methods.

The signature base string includes the following components of the HTTP request:

  • The HTTP request method (e.g., "GET", "POST", etc.).

  • The authority as declared by the HTTP "Host" request header field.

  • The path and query components of the request resource URI.

  • he protocol parameters excluding the "oauth_signature".

The signature base string does not cover the entire HTTP request. Most notably, it does not include the entity-body in most requests, nor does it include most HTTP entity-headers.

The signature base string is constructed by concatenating together, in order, the following HTTP request elements:

  1. The HTTP request method in uppercase. For example: "HEAD", "GET", "POST", etc. If the request uses a custom HTTP method, it MUST be encoded (Section 3.6).

  2. An "&" character (ASCII code 38).

  3. The base string URI from Section 3.4.1.2, after being encoded (Section 3.6).

  4. An "&" character (ASCII code 38).

  5. The request parameters as normalized in Section 3.4.1.3.2, after being encoded (Section 3.6).

Explained shortly below the example.

Example:

POST /oauth/token HTTP/1.1
Host: https://apisandbox.openbankproject.com
Content-Type: application/x-www-form-urlencoded
Authorization: OAuth
oauth_consumer_key="91919",
oauth_token="OGESD9MrWQEGPXOyPjHCRrCw7BPelWJjnomibV6bePU",
oauth_signature_method="HMAC-SHA256",
oauth_timestamp="1340878170",
oauth_nonce="DFXOQFZVK8K46KDR11",
oauth_signature="bYT5CMsGcbgUdFHObYMEfcx6bsw%3D"

Is represented by the following signature base string (line breaks are for display purposes only):

POST&https%3A%2F%2Fhttps://apisandbox.openbankproject.com&oauth_consumer_key%3D91919%26oauth_nonce%3DDFXOQFZVK8K46KDR11%26oauth_signature_method%3Dhmac-sha256%26oauth_timestamp%3D1340878170%26oauth_token%3DOGESD9MrWQEGPXOyPjHCRrCw7BPelWJjnomibV6bePU%26oauth_verifier%3DT0dXUDBZR09LUVlGTU9NSlhIUUc%26oauth_version%3D1

The request parameters normalization :

  1. The name and value of each parameter are encoded Section 3.6.

  2. The parameters are sorted by name, using ascending byte value ordering.

  3. The name of each parameter is concatenated to its corresponding value using an "=" character (ASCII code 61) as a separator, even if the value is empty.

  4. The sorted name/value pairs are concatenated together into a single string by using an "&" character (ASCII code 38) as separator.

B) Signing the request :

The Open Bank Project OAuth 1.0 implementation uses the “HMAC-SHA1” and “HMAC-SHA256” as signing methods. The key to sign the base string is the concatenation of the consumer secret and the token secret with the “&” character in the middle like this: oauth_consumer_secret&oauth_token_secret, in the first step the application does not have yet a token so it will be an empty string.

The signature that results from the signature process MUST be encoded in base 64 also since the protocol requires encoding all the OAuth parameters.

Illustration of integration with a bank back-end :

The following link shows how the integration of the OAuth process would be with a bank back-end: https://github.com/OpenBankProject/OBP-API/wiki/OAuth-Integration-Illustration

OAuth 2

OAuth2 is allowed on this instance.

OAuth2 is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service, in this case any OBP REST call. It works by delegating user authentication to the service that hosts the user account, and authorizing third-party applications to access the user account. OAuth 2 provides authorization flows for web and desktop applications, and mobile devices.

OAuth2 Roles

The following is a general introduction to a so called "3 legged OAuth2" flow:

  • Resource Owner
  • Client
  • Resource Server
  • Authorization Server

Resource Owner: User

The resource owner is the user who authorizes an application to access their account. The application's access to the user's account is limited to the "scope" of the authorization granted (e.g. openid).

Authorization Server: API

The authorization server verifies the identity of the user then issues access tokens to the application. E.g. MITREid Connect

Resource Server: API

The resource server hosts the protected user resources. E.g. OBP-API

Client: Application

The client is the application that wants to access the user's resource. In order to do that, it must be authorized by the user, and the authorization must be validated by the Authorization Server: API.

Authorization Grant

OAuth 2 defines four grant types, each of which is useful in different cases:

  • Authorization Code: used with server-side Applications

  • Implicit: used with Mobile Apps or Web Applications (applications that run on the user's device)

  • Resource Owner Password Credentials: used with trusted Applications, such as those owned by the service itself

  • Client Credentials: used with Applications API access

OBP-API supports at the moment only Authorization Code

Step 1: Get your App key

Sign up or login as a developer

Register your App key HERE

Copy and paste the CONSUMER_KEY, CONSUMER_SECRET and REDIRECT_URL for the subsequent steps below.

Step 2: Initiate the OAuth 2.0 / OpenID Connect Flow

Once you have registered your App you should initiate the OAuth2 / OIDC flow using the following URL

https://oauth2.ofpilot.com/hydra-public/oauth2/auth

WITH THE following parameters:

https://oauth2.ofpilot.com/hydra-public/oauth2/auth?client_id=YOUR-CLIENT-ID&response_type=code&state=GENERATED_BY_YOUR_APP&scope=openid+offline+ReadAccountsBasic+ReadAccountsDetail+ReadBalances+ReadTransactionsBasic+ReadTransactionsDebits+ReadTransactionsDetail&redirect_uri=https%3A%2F%2FYOUR-APP.com%2Fmain.html

For further information please see here

In this sandbox, this will cause the following flow:

1) The User is authorised using OAuth2 / OpenID Connect against the banks authentication system
2) The User grants consent to the App on the bank's Consent page.
3) The User grants access to one or more accounts that they own on the bank's Account Selection page
4) The User is redirected back to the App where they can now see the Accounts they have selected.

An example App using this flow can be found here

OAuth 2 with Google

OAuth2 is allowed on this instance.

OpenID Connect with Google

Introduction

Google's OAuth 2.0 APIs can be used for both authentication and authorization. This document describes our OAuth 2.0 implementation for authentication, which conforms to the OpenID Connect specification, and is OpenID Certified.
For complete documentation please refer to the official doc's page: OpenID Connect

OpenID Connect with Google Image

Obtain OAuth 2.0 credentials

Please refer to the official doc's page: OpenID Connect
In case you use Google's OAuth 2.0 Playground
example of an response is shown below:
{
"access_token": "ya29.a0Adw1xeVr_WAYaipiH_6QKCFjIFsnZxW7kbxA8a2RU_uy5meEufErwPDLSHMga8IEQghNSX2GbkOfZUQb6j_fMGHL_HaW3RoULZq5AayUdEjI9bC4TMe-Nd4cZR17C0Rg3GLNzuHTXXe05UyMmNODZ6Up0aXZBBTHl-4",
"id_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImE1NDFkNmVmMDIyZDc3YTIzMThmN2RkNjU3ZjI3NzkzMjAzYmVkNGEiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20iLCJhenAiOiI0MDc0MDg3MTgxOTIuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJhdWQiOiI0MDc0MDg3MTgxOTIuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJzdWIiOiIxMTM5NjY4NTQyNDU3ODA4OTI5NTkiLCJlbWFpbCI6Im1hcmtvLm1pbGljLnNyYmlqYUBnbWFpbC5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwiYXRfaGFzaCI6ImtrcENIWUFaSTZVOFZiZEJsRHNfX1EiLCJuYW1lIjoiTWFya28gTWlsacSHIiwicGljdHVyZSI6Imh0dHBzOi8vbGg1Lmdvb2dsZXVzZXJjb250ZW50LmNvbS8tWGQ0NGhuSjZURG8vQUFBQUFBQUFBQUkvQUFBQUFBQUFBQUEvQUtGMDVuQ1pyaTdmWHdkUUhuZUNwN09pTVh1WGlOMkpVQS9zOTYtYy9waG90by5qcGciLCJnaXZlbl9uYW1lIjoiTWFya28iLCJmYW1pbHlfbmFtZSI6Ik1pbGnEhyIsImxvY2FsZSI6ImVuIiwiaWF0IjoxNTg0NTIxNDU3LCJleHAiOjE1ODQ1MjUwNTd9.LgwY-OhltYS2p91l2Lt4u5lUR5blR7L8097J0ZpK0GyxWxOlnhSouk9MRMmyfSGuYfWKBtdSUy3Esaphk2f7wpLS-wBx3KJpvrXhgbsyemt9s7eu5bAdHaCteO8MqHPjbU9tych8iH0tA1MSL_tVZ73hy56rS2irzIC33wYDoBf8C5nEOd2uzQ758ydK5QvvdFwRgkLhKDS8vq2qVJTWgtk9VVd5JwJ5OfiVimXfGUzNJmGreEJKj14iUj-78REybpUbI9mGevRhjLPhs51Uc9j-SsdRMymVbVhVxlbsWAPTpjLAJnOodeHzAvmKFkOUfahQHHctx4fl8V3PVYf1aA",
"expires_in": 3599,
"token_type": "Bearer",
"scope": "https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email openid",
"refresh_token": "1//04w7RCdl9ZnG-CgYIARAAGAQSNwF-L9IrNZVxs6fliP7xAlHjKcZpfpw7JoYyBsvxKMD7n0xyB74G8aRlFoBkkCbloETrWMU6yOA"
}
Note: The OAuth Playground will automatically revoke refresh tokens after 24h. You can avoid this by specifying your own application OAuth credentials using the Configuration panel.

An ID token's payload

	{
	"iss": "https://accounts.google.com",
	"azp": "407408718192.apps.googleusercontent.com",
	"aud": "407408718192.apps.googleusercontent.com",
	"sub": "113966854245780892959",
	"email": "marko.milic.srbija@gmail.com",
	"email_verified": true,
	"at_hash": "nGKRToKNnVA28H6MhwXBxw",
	"name": "Marko Milić",
	"picture": "https://lh5.googleusercontent.com/-Xd44hnJ6TDo/AAAAAAAAAAI/AAAAAAAAAAA/AKxrwcadwzhm4N4tWk5E8Avxi-ZK6ks4qg/s96-c/photo.jpg",
	"given_name": "Marko",
	"family_name": "Milić",
	"locale": "en",
	"iat": 1547705691,
	"exp": 1547709291
	}

Try a REST call using the authorization's header

	Using your favorite http client:

	GET /obp/v3.0.0/users/current

Body

Leave Empty!

Headers:

	Authorization: Bearer ID_TOKEN

Here is it all together:

GET /obp/v3.0.0/users/current HTTP/1.1
	Host: https://apisandbox.openbankproject.com
	Authorization: Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjA4ZDMyNDVjNjJmODZiNjM2MmFmY2JiZmZlMWQwNjk4MjZkZDFkYzEiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20iLCJhenAiOiI0MDc0MDg3MTgxOTIuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJhdWQiOiI0MDc0MDg3MTgxOTIuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJzdWIiOiIxMTM5NjY4NTQyNDU3ODA4OTI5NTkiLCJlbWFpbCI6Im1hcmtvLm1pbGljLnNyYmlqYUBnbWFpbC5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwiYXRfaGFzaCI6IkFvYVNGQTlVTTdCSGg3YWZYNGp2TmciLCJuYW1lIjoiTWFya28gTWlsacSHIiwicGljdHVyZSI6Imh0dHBzOi8vbGg1Lmdvb2dsZXVzZXJjb250ZW50LmNvbS8tWGQ0NGhuSjZURG8vQUFBQUFBQUFBQUkvQUFBQUFBQUFBQUEvQUt4cndjYWR3emhtNE40dFdrNUU4QXZ4aS1aSzZrczRxZy9zOTYtYy9waG90by5qcGciLCJnaXZlbl9uYW1lIjoiTWFya28iLCJmYW1pbHlfbmFtZSI6Ik1pbGnEhyIsImxvY2FsZSI6ImVuIiwiaWF0IjoxNTQ3NzExMTE1LCJleHAiOjE1NDc3MTQ3MTV9.MKsyecCSKS4Y0C8R4JP0J0d2Oa-xahvMAbtfFrGHncTm8xBgeaNb50XSJn20ak1YyA8hZiRP2M3el0f4eIVQZsMMa22MrwaiL8pLb1zGfawDLPb1RvOmoCWTDJGc_s1qQMlyc21Wenr9rjuu1bQCerGTYM6M0Aq-Uu_GT0lCEjz5WVDI5xDUf4Mhdi8HYq7UQ1kGz1gQFiBm5nI3_xtYm75EfXFeDg3TejaMmy36NpgtwN_vwpHByoHE5BoTl2J55rJ2creZZ7CmtZttm-9HsT6v1vxT8zi0RXObFrZSk-LgfF0tJQcGZ5LXQZL0yMKXPQVFIMCg8J0Gg7l_QACkCA
	Cache-Control: no-cache

CURL example:

	curl -X GET
	https://apisandbox.openbankproject.com/obp/v3.0.0/users/current
	-H 'Authorization: Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjA4ZDMyNDVjNjJmODZiNjM2MmFmY2JiZmZlMWQwNjk4MjZkZDFkYzEiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20iLCJhenAiOiI0MDc0MDg3MTgxOTIuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJhdWQiOiI0MDc0MDg3MTgxOTIuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJzdWIiOiIxMTM5NjY4NTQyNDU3ODA4OTI5NTkiLCJlbWFpbCI6Im1hcmtvLm1pbGljLnNyYmlqYUBnbWFpbC5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwiYXRfaGFzaCI6IkFvYVNGQTlVTTdCSGg3YWZYNGp2TmciLCJuYW1lIjoiTWFya28gTWlsacSHIiwicGljdHVyZSI6Imh0dHBzOi8vbGg1Lmdvb2dsZXVzZXJjb250ZW50LmNvbS8tWGQ0NGhuSjZURG8vQUFBQUFBQUFBQUkvQUFBQUFBQUFBQUEvQUt4cndjYWR3emhtNE40dFdrNUU4QXZ4aS1aSzZrczRxZy9zOTYtYy9waG90by5qcGciLCJnaXZlbl9uYW1lIjoiTWFya28iLCJmYW1pbHlfbmFtZSI6Ik1pbGnEhyIsImxvY2FsZSI6ImVuIiwiaWF0IjoxNTQ3NzExMTE1LCJleHAiOjE1NDc3MTQ3MTV9.MKsyecCSKS4Y0C8R4JP0J0d2Oa-xahvMAbtfFrGHncTm8xBgeaNb50XSJn20ak1YyA8hZiRP2M3el0f4eIVQZsMMa22MrwaiL8pLb1zGfawDLPb1RvOmoCWTDJGc_s1qQMlyc21Wenr9rjuu1bQCerGTYM6M0Aq-Uu_GT0lCEjz5WVDI5xDUf4Mhdi8HYq7UQ1kGz1gQFiBm5nI3_xtYm75EfXFeDg3TejaMmy36NpgtwN_vwpHByoHE5BoTl2J55rJ2creZZ7CmtZttm-9HsT6v1vxT8zi0RXObFrZSk-LgfF0tJQcGZ5LXQZL0yMKXPQVFIMCg8J0Gg7l_QACkCA'
	-H 'Cache-Control: no-cache'
	-H 'Postman-Token: aa812d04-eddd-4752-adb7-4d56b3a98f36'

And we get the response:

	{
		"user_id": "6d411bce-50c1-4eb8-b8b0-3953e4211773",
		"email": "marko.milic.srbija@gmail.com",
		"provider_id": "113966854245780892959",
		"provider": "https://accounts.google.com",
		"username": "Marko Milić",
		"entitlements": {
		"list": []
	}
	}

SCA (Strong Customer Authentication)

SCA is the process by which a Customer of the Bank securely identifies him/her self to the Bank.

Generally this involves using an Out Of Band (OOB) form of communication e.g. a One Time Password (OTP) / code sent to a mobile phone.

In the OBP APIs, SCA is invoked during Transaction Requests and Consent creation.

See the following endpoints:

Create Consent via SMS
Create Consent via Email (for testing purposes)
Answer Consent Challenge

Create Transaction Request
Answer Transaction Request Challenge

Possible SCA flows:

obp-sca-image-1

Scenario 1: Onboarding a User

1) Create a user

Action:

POST https://apisandbox.openbankproject.com/obp/v4.0.0/users

Body:

{  "email":"ellie@example.com",  "username":"ellie",  "password":"P@55w0RD123",  "first_name":"Ellie",  "last_name":"Williams"}

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token-from-direct-login"

Please note the user_id

2) Create customer

Requires CanCreateCustomer and CanCreateUserCustomerLink roles

Action:

POST https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/customers

Body:

{  "legal_name":"Eveline Tripman",  "mobile_phone_number":"+44 07972 444 876",  "email":"eveline@example.com",  "face_image":{    "url":"www.openbankproject",    "date":"2017-09-19T00:00:00Z"  },  "date_of_birth":"2017-09-19T00:00:00Z",  "relationship_status":"single",  "dependants":10,  "dob_of_dependants":["2017-09-19T00:00:00Z"],  "credit_rating":{    "rating":"OBP",    "source":"OBP"  },  "credit_limit":{    "currency":"EUR",    "amount":"10"  },  "highest_education_attained":"Master",  "employment_status":"worker",  "kyc_status":true,  "last_ok_date":"2017-09-19T00:00:00Z",  "title":"Dr.",  "branch_id":"DERBY6",  "name_suffix":"Sr"}

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token-from-direct-login"

3) List customers for the user

Action:

GET https://apisandbox.openbankproject.com/obp/v4.0.0/users/current/customers

Body:

Leave empty!

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token-from-direct-login"

4) Create user customer link

Requires CanCreateCustomer and CanCreateUserCustomerLink roles

Action:

POST https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/user_customer_links

Body:

{ "user_customer_link_id":"String", "customer_id":"customer-id-from-step-2", "user_id":"user-id-from-step-1", "date_inserted":"2018-03-22T00:08:00Z", "is_active":true }

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token-from-direct-login"

5) Create account

Requires CanCreateAccount role

Action:

PUT https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID

Body:

{  "user_id":"userid-from-step-1",  "label":"My Account",  "product_code":"AC",  "balance":{    "currency":"EUR",    "amount":"10"  },  "branch_id":"DERBY6",  "account_routing":{    "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:

Content-Type:  application/json

Authorization: DirectLogin token="your-token-from-direct-login"

6) List accounts

Action:

GET https://apisandbox.openbankproject.com/obp/v4.0.0/my/banks/BANK_ID/accounts/account-id-from-step-5/account

Body:

Leave empty!

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token-from-direct-login"

7) Create card

Requires CanCreateCardsForBank role

Action:

POST https://apisandbox.openbankproject.com/obp/v4.0.0/management/banks/BANK_ID/cards

Body:

{ "card_number":"364435172576215", "card_type":"Credit", "name_on_card":"SusanSmith", "issue_number":"1", "serial_number":"1324234", "valid_from_date":"2017-09-19T00:00:00Z", "expires_date":"2017-09-19T00:00:00Z", "enabled":true, "technology":"technology1", "networks":["network1","network2"], "allows":["credit","debit"], "account_id":"account_id from step 5", "replacement":{ "requested_date":"2017-09-19T00:00:00Z", "reason_requested":"RENEW" }, "pin_reset":[{ "requested_date":"2017-09-19T00:00:00Z", "reason_requested":"FORGOT" },{ "requested_date":"2020-01-18T16:39:23Z", "reason_requested":"GOOD_SECURITY_PRACTICE" }], "collected":"2017-09-19T00:00:00Z", "posted":"2017-09-19T00:00:00Z", "customer_id":"customer_id from step 2"}

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token-from-direct0login"

8) List cards

Action:

GET https://apisandbox.openbankproject.com/obp/v3.0.0/cards

Body:

Leave empty!

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token-from-direct0login"

Scenario 2: Create a Public Account

1) Create account

Create an account as described in Step 5 of section Onboarding a user

2) Create a view

Action:

POST https://apisandbox.openbankproject.com/obp/v3.0.0/banks/BANK_ID/accounts/your-account-id-from-step-1/views

Body:

{ "name":"_test", "description":"This view is for family", "metadata_view":"_test", "is_public":true, "which_alias_to_use":"family", "hide_metadata_if_alias_used":false, "allowed_actions":["can_see_transaction_this_bank_account","can_see_transaction_other_bank_account","can_see_transaction_metadata","can_see_transaction_label","can_see_transaction_amount","can_see_transaction_type","can_see_transaction_currency","can_see_transaction_start_date","can_see_transaction_finish_date","can_see_transaction_balance","can_see_comments","can_see_narrative","can_see_tags","can_see_images","can_see_bank_account_owners","can_see_bank_account_type","can_see_bank_account_balance","can_see_bank_account_currency","can_see_bank_account_label","can_see_bank_account_national_identifier","can_see_bank_account_swift_bic","can_see_bank_account_iban","can_see_bank_account_number","can_see_bank_account_bank_name","can_see_other_account_national_identifier","can_see_other_account_swift_bic","can_see_other_account_iban","can_see_other_account_bank_name","can_see_other_account_number","can_see_other_account_metadata","can_see_other_account_kind","can_see_more_info","can_see_url","can_see_image_url","can_see_open_corporates_url","can_see_corporate_location","can_see_physical_location","can_see_public_alias","can_see_private_alias","can_add_more_info","can_add_url","can_add_image_url","can_add_open_corporates_url","can_add_corporate_location","can_add_physical_location","can_add_public_alias","can_add_private_alias","can_delete_corporate_location","can_delete_physical_location","can_edit_narrative","can_add_comment","can_delete_comment","can_add_tag","can_delete_tag","can_add_image","can_delete_image","can_add_where_tag","can_see_where_tag","can_delete_where_tag","can_create_counterparty","can_see_bank_routing_scheme","can_see_bank_routing_address","can_see_bank_account_routing_scheme","can_see_bank_account_routing_address","can_see_other_bank_routing_scheme","can_see_other_bank_routing_address","can_see_other_account_routing_scheme","can_see_other_account_routing_address","can_query_available_funds","can_add_transaction_request_to_own_account","can_add_transaction_request_to_any_account","can_see_bank_account_credit_limit","can_create_direct_debit","can_create_standing_order"]} |
Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token"

3) Grant user access to view

Action:

POST https://apisandbox.openbankproject.com/obp/v3.0.0/banks/BANK_ID/accounts/your-account-id-from-step-1/permissions/PROVIDER/PROVIDER_ID/views/view-id-from-step-2

Body:

{  "json_string":"{}"}

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token"

Scenario 3: Create counterparty and make payment

1) Create counterparty

Action:

POST https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/accounts/account-id-from-account-creation/VIEW_ID/counterparties

Body:

{ "name":"CounterpartyName", "description":"My landlord", "other_account_routing_scheme":"accountNumber", "other_account_routing_address":"7987987-2348987-234234", "other_account_secondary_routing_scheme":"IBAN", "other_account_secondary_routing_address":"DE89370400440532013000", "other_bank_routing_scheme":"bankCode", "other_bank_routing_address":"10", "other_branch_routing_scheme":"branchNumber", "other_branch_routing_address":"10010", "is_beneficiary":true, "bespoke":[{ "key":"englishName", "value":"english Name" }]} |
Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token"

2) Make payment by SEPA

Action:

POST https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/SEPA/transaction-requests

Body:

{  "value":{    "currency":"EUR",    "amount":"10"  },  "to":{    "iban":"123"  },  "description":"This is a SEPA Transaction Request",  "charge_policy":"SHARED"}

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token"        |

3) Make payment by COUNTERPARTY

Action:

POST https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/COUNTERPARTY/transaction-requests

Body:

{  "to":{    "counterparty_id":"counterparty-id-from-step-1"  },  "value":{    "currency":"EUR",    "amount":"10"  },  "description":"A description for the transaction to the counterparty",  "charge_policy":"SHARED"}

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token"

Scenario 4: Grant account access to another User

1) Create account

Create an account as described in Step 5 of section Onboarding a user

2) Create a view (private)

Action:

POST https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/accounts/your-account-id-from-step-1/views

Body:

{  "name":"_test", "description":"good", "is_public":false, "which_alias_to_use":"accountant", "hide_metadata_if_alias_used":false,  "allowed_actions": ["can_see_transaction_this_bank_account", "can_see_transaction_other_bank_account", "can_see_transaction_metadata", "can_see_transaction_label", "can_see_transaction_amount", "can_see_transaction_type", "can_see_transaction_currency", "can_see_transaction_start_date", "can_see_transaction_finish_date", "can_see_transaction_balance", "can_see_comments", "can_see_narrative", "can_see_tags", "can_see_images", "can_see_bank_account_owners", "can_see_bank_account_type", "can_see_bank_account_balance", "can_see_bank_account_currency", "can_see_bank_account_label", "can_see_bank_account_national_identifier", "can_see_bank_account_swift_bic", "can_see_bank_account_iban", "can_see_bank_account_number", "can_see_bank_account_bank_name", "can_see_other_account_national_identifier", "can_see_other_account_swift_bic", "can_see_other_account_iban", "can_see_other_account_bank_name", "can_see_other_account_number", "can_see_other_account_metadata", "can_see_other_account_kind", "can_see_more_info", "can_see_url", "can_see_image_url", "can_see_open_corporates_url", "can_see_corporate_location", "can_see_physical_location", "can_see_public_alias", "can_see_private_alias", "can_add_more_info", "can_add_url", "can_add_image_url", "can_add_open_corporates_url", "can_add_corporate_location", "can_add_physical_location", "can_add_public_alias", "can_add_private_alias", "can_delete_corporate_location", "can_delete_physical_location", "can_edit_narrative", "can_add_comment", "can_delete_comment", "can_add_tag", "can_delete_tag", "can_add_image", "can_delete_image", "can_add_where_tag", "can_see_where_tag", "can_delete_where_tag", "can_create_counterparty", "can_see_bank_routing_scheme", "can_see_bank_routing_address", "can_see_bank_account_routing_scheme", "can_see_bank_account_routing_address", "can_see_other_bank_routing_scheme", "can_see_other_bank_routing_address", "can_see_other_account_routing_scheme", "can_see_other_account_routing_address"]}

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token"

3) Get User (Current)

Action:

GET https://apisandbox.openbankproject.com/obp/v4.0.0/users/current

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token"

4) Grant user access to himself

Action:

POST https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/accounts/your-account-id-from-step-1/account-access/grant 

Body:

{  "user_id":"your-user-id-from-step3",  "view":{    "view_id":"_test",    "is_system":false  }}

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token"			

5) Grant user access to view to another user

Action:

POST https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/accounts/your-account-id-from-step-1/account-access/grant 

Body:

{  "user_id":"another-user-id",  "view":{    "view_id":"_test",    "is_system":false  }}

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token"

Scenario 5: Onboarding a User using Auth Context

1) Create a user

Action:

POST https://apisandbox.openbankproject.com/obp/v3.0.0/users

Body:

{  "email":"ellie@example.com",  "username":"ellie",  "password":"P@55w0RD123",  "first_name":"Ellie",  "last_name":"Williams"}

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token-from-direct-login"

Please note the user_id

2) Create User Auth Context

These key value pairs will be propagated over connector to adapter and to bank. So the bank can use these key value paris
to map obp user to real bank customer.

Action:

POST https://apisandbox.openbankproject.com/obp/obp/v4.0.0/users/USER_ID/auth-context

Body:

{  "key":"CUSTOMER_NUMBER",  "value":"78987432"}

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token-from-direct-login"

3) Create customer

Requires CanCreateCustomer or canCreateCustomerAtAnyBank roles

Action:

POST https://apisandbox.openbankproject.com/obp/v3.1.0/banks/BANK_ID/customers

Body:

{  "user_id":"user-id-from-step-1", "customer_number":"687687678", "legal_name":"NONE",  "mobile_phone_number":"+44 07972 444 876", "email":"person@example.com", "face_image":{    "url":"www.openbankproject",    "date":"2013-01-22T00:08:00Z"  },  "date_of_birth":"2013-01-22T00:08:00Z",  "relationship_status":"Single",  "dependants":5,  "dob_of_dependants":["2013-01-22T00:08:00Z"],  "credit_rating":{    "rating":"OBP",    "source":"OBP"  },  "credit_limit":{    "currency":"EUR",    "amount":"10"  },  "highest_education_attained":"Bachelor’s Degree",  "employment_status":"Employed",  "kyc_status":true,  "last_ok_date":"2013-01-22T00:08:00Z"}

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token-from-direct-login"

4) Get Customers for Current User

Action:

GET https://apisandbox.openbankproject.com/obp/v3.0.0/users/current/customers

Body:

Leave empty!

Headers:

Content-Type:  application/json

Authorization: DirectLogin token="your-token-from-direct-login"

Template.attributeName

Example value: SPECIAL_TAX_NUMBER

Description: Attribute name

Template.attributeType

Example value: STRING

Description: Attribute type.

Transaction

Records of successful movements of money from / to an Account. OBP Transactions don't contain any "draft" or "pending" Transactions. (see Transaction Requests). Transactions contain infomration including type, description, from, to, currency, amount and new balance information.

Transaction Requests

Transaction Requests are records of transaction / payment requests coming to the API. They may or may not result in Transactions (following authorisation, security challenges and sufficient funds etc.)

A successful Transaction Request results in a Transaction.

For more information see here

Transaction Requests.Transaction Request Refund Reason Code

Example value: CUST

Description: Defines the reason code of a transaction refund request (e.g. a SEPA Credit Transfer Scheme reason code).

Transaction Requests.Transaction Request Type

Example value: SEPA

Description: The Transaction Request Type defines the request body that is required - and the logic / flow of the Transaction Request. Allowed values include SEPA, COUNTERPARTY and SANDBOX_TAN.

Transaction Requests.id

Example value: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1

Description: The Transaction Request Id

Transaction.attributeId

Example value: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

Description: Transaction attribute id

Transaction.attributeName

Example value: HOUSE_RENT

Description: Transaction attribute name

Transaction.attributeType

Example value: DATE_WITH_DAY

Description: Transaction attribute type.

Transaction.attributeValue

Example value: 123456789

Description: Transaction attribute value.

Transaction.otherAccountProvider

Example value:

Description:

Transaction.transactionDescription

Example value: For the piano lesson in June 2018 - Invoice No: 68

Description: A description or reference for the transaction

Transaction.transactionId

Example value: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

Description: The Transaction ID used in URLs. Used to store Metadata for the Transaction.

Transaction.transactionType

Example value: DEBIT

Description: A code for the type of transaction

User

The entity that accesses the API with a login / authorisation token and has access to zero or more resources on the OBP API. The User is linked to the core banking user / customer at the South Side Adapter layer.

Link Users and Customers in a many to many relationship. A User can represent many Customers (e.g. the bank may have several Customer records for the same individual or a dependant). In this way Customers can easily be attached / detached from Users.

User.password

Example value: password

Description: The password the user uses to authenticate.

User.provider

The name of the authentication service. e.g. the OBP hostname or kafka if users are authenticated over Kafka.

User.provider_id

The id of the user given by the authentication provider.

User.userId

Example value: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

Description: A string that MUST uniquely identify the user on this OBP instance.

User.userNameExample

Example value: felixsmith

Description: The userName the user uses to authenticate.

User.user_id

An identifier that MUST NOT leak the user name or other identifier nomrally used by the customer or bank staff. It SHOULD be a UUID and MUST be unique on the OBP instance.

Example value: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

User.username

Example value: felixsmith

Description: The username the user uses to authenticate.

accessiblefeatures

Example value: no-example-provided

Description: no-description-provided

account

Example value: no-example-provided

Description: no-description-provided

account_application_id

Example value: no-example-provided

Description: no-description-provided

account_applications

Example value: no-example-provided

Description: no-description-provided

account_attribute_id

Example value: no-example-provided

Description: no-description-provided

account_attributes

Example value: no-example-provided

Description: no-description-provided

account_otp

Example value: no-example-provided

Description: no-description-provided

account_routing

Example value: no-example-provided

Description: no-description-provided

account_routings

Example value: no-example-provided

Description: no-description-provided

account_rules

Example value: no-example-provided

Description: no-description-provided

account_webhook_id

Example value: no-example-provided

Description: no-description-provided

accounts

Example value: no-example-provided

Description: no-description-provided

active

Example value: true

Description: no-description-provided

actual_date

Example value: no-example-provided

Description: no-description-provided

adapter_implementation

Example value: no-example-provided

Description: no-description-provided

address

Example value: no-example-provided

Description: no-description-provided

addresses

Example value: no-example-provided

Description: no-description-provided

akka

Example value: no-example-provided

Description: no-description-provided

alias

Example value: no-example-provided

Description: no-description-provided

allowed_actions

Example value: no-example-provided

Description: no-description-provided

allowed_attempts

Example value: no-example-provided

Description: no-description-provided

allows

Example value: no-example-provided

Description: no-description-provided

answer

Example value: no-example-provided

Description: no-description-provided

api_version

Example value: no-example-provided

Description: no-description-provided

app_name

Example value: no-example-provided

Description: no-description-provided

app_type

Example value: no-example-provided

Description: no-description-provided

atm_id

Example value: no-example-provided

Description: no-description-provided

atms

Example value: no-example-provided

Description: no-description-provided

attribute_definition_id

Example value: no-example-provided

Description: no-description-provided

attribute_id

Example value: no-example-provided

Description: no-description-provided

attributes

Example value: no-example-provided

Description: no-description-provided

auth_context_update_id

Example value: no-example-provided

Description: no-description-provided

available_funds_request_id

Example value: no-example-provided

Description: no-description-provided

average_response_time

Example value: no-example-provided

Description: no-description-provided

bad_attempts_since_last_success_or_reset

Example value: no-example-provided

Description: no-description-provided

balance

Example value: 10

Description: no-description-provided

bank

Example value: no-example-provided

Description: no-description-provided

bank_code

Example value: no-example-provided

Description: no-description-provided

bank_id_pattern

Example value: no-example-provided

Description: no-description-provided

bank_routing

Example value: no-example-provided

Description: no-description-provided

bank_routings

Example value: no-example-provided

Description: no-description-provided

bankid

Example value: no-example-provided

Description: no-description-provided

banks

Example value: no-example-provided

Description: no-description-provided

bespoke

Example value: no-example-provided

Description: no-description-provided

bic

Example value: BUKBGB22

Description: The Business Identifier Code

branch_number

Example value: no-example-provided

Description: no-description-provided

branch_routing

Example value: no-example-provided

Description: no-description-provided

branch_routings

Example value: no-example-provided

Description: no-description-provided

branch_type

Example value: no-example-provided

Description: no-description-provided

branches

Example value: no-example-provided

Description: no-description-provided

cache

Example value: no-example-provided

Description: no-description-provided

calls_made

Example value: no-example-provided

Description: no-description-provided

can_add_comment

Example value: no-example-provided

Description: no-description-provided

can_add_corporate_location

Example value: no-example-provided

Description: no-description-provided

can_add_counterparty

Example value: no-example-provided

Description: no-description-provided

can_add_image

Example value: no-example-provided

Description: no-description-provided

can_add_image_url

Example value: no-example-provided

Description: no-description-provided

can_add_more_info

Example value: no-example-provided

Description: no-description-provided

can_add_open_corporates_url

Example value: no-example-provided

Description: no-description-provided

can_add_physical_location

Example value: no-example-provided

Description: no-description-provided

can_add_private_alias

Example value: no-example-provided

Description: no-description-provided

can_add_public_alias

Example value: no-example-provided

Description: no-description-provided

can_add_tag

Example value: no-example-provided

Description: no-description-provided

can_add_transaction_request_to_any_account

Example value: no-example-provided

Description: no-description-provided

can_add_transaction_request_to_own_account

Example value: no-example-provided

Description: no-description-provided

can_add_url

Example value: no-example-provided

Description: no-description-provided

can_add_where_tag

Example value: no-example-provided

Description: no-description-provided

can_be_seen_on_views

Example value: no-example-provided

Description: no-description-provided

can_create_direct_debit

Example value: no-example-provided

Description: no-description-provided

can_create_standing_order

Example value: no-example-provided

Description: no-description-provided

can_delete_comment

Example value: no-example-provided

Description: no-description-provided

can_delete_corporate_location

Example value: no-example-provided

Description: no-description-provided

can_delete_image

Example value: no-example-provided

Description: no-description-provided

can_delete_physical_location

Example value: no-example-provided

Description: no-description-provided

can_delete_tag

Example value: no-example-provided

Description: no-description-provided

can_delete_where_tag

Example value: no-example-provided

Description: no-description-provided

can_edit_owner_comment

Example value: no-example-provided

Description: no-description-provided

can_query_available_funds

Example value: no-example-provided

Description: no-description-provided

can_see_bank_account_balance

Example value: no-example-provided

Description: no-description-provided

can_see_bank_account_bank_name

Example value: no-example-provided

Description: no-description-provided

can_see_bank_account_credit_limit

Example value: no-example-provided

Description: no-description-provided

can_see_bank_account_currency

Example value: no-example-provided

Description: no-description-provided

can_see_bank_account_iban

Example value: no-example-provided

Description: no-description-provided

can_see_bank_account_label

Example value: no-example-provided

Description: no-description-provided

can_see_bank_account_national_identifier

Example value: no-example-provided

Description: no-description-provided

can_see_bank_account_number

Example value: no-example-provided

Description: no-description-provided

can_see_bank_account_owners

Example value: no-example-provided

Description: no-description-provided

can_see_bank_account_routing_address

Example value: no-example-provided

Description: no-description-provided

can_see_bank_account_routing_scheme

Example value: no-example-provided

Description: no-description-provided

can_see_bank_account_swift_bic

Example value: no-example-provided

Description: no-description-provided

can_see_bank_account_type

Example value: no-example-provided

Description: no-description-provided

can_see_bank_routing_address

Example value: no-example-provided

Description: no-description-provided

can_see_bank_routing_scheme

Example value: no-example-provided

Description: no-description-provided

can_see_comments

Example value: no-example-provided

Description: no-description-provided

can_see_corporate_location

Example value: no-example-provided

Description: no-description-provided

can_see_image_url

Example value: no-example-provided

Description: no-description-provided

can_see_images

Example value: true

Description: no-description-provided

can_see_more_info

Example value: no-example-provided

Description: no-description-provided

can_see_open_corporates_url

Example value: no-example-provided

Description: no-description-provided

can_see_other_account_bank_name

Example value: no-example-provided

Description: no-description-provided

can_see_other_account_iban

Example value: no-example-provided

Description: no-description-provided

can_see_other_account_kind

Example value: no-example-provided

Description: no-description-provided

can_see_other_account_metadata

Example value: no-example-provided

Description: no-description-provided

can_see_other_account_national_identifier

Example value: no-example-provided

Description: no-description-provided

can_see_other_account_number

Example value: no-example-provided

Description: no-description-provided

can_see_other_account_routing_address

Example value: no-example-provided

Description: no-description-provided

can_see_other_account_routing_scheme

Example value: no-example-provided

Description: no-description-provided

can_see_other_account_swift_bic

Example value: no-example-provided

Description: no-description-provided

can_see_other_bank_routing_address

Example value: no-example-provided

Description: no-description-provided

can_see_other_bank_routing_scheme

Example value: no-example-provided

Description: no-description-provided

can_see_owner_comment

Example value: no-example-provided

Description: no-description-provided

can_see_physical_location

Example value: no-example-provided

Description: no-description-provided

can_see_private_alias

Example value: no-example-provided

Description: no-description-provided

can_see_public_alias

Example value: no-example-provided

Description: no-description-provided

can_see_tags

Example value: no-example-provided

Description: no-description-provided

can_see_transaction_amount

Example value: no-example-provided

Description: no-description-provided

can_see_transaction_balance

Example value: no-example-provided

Description: no-description-provided

can_see_transaction_currency

Example value: no-example-provided

Description: no-description-provided

can_see_transaction_description

Example value: no-example-provided

Description: no-description-provided

can_see_transaction_finish_date

Example value: no-example-provided

Description: no-description-provided

can_see_transaction_metadata

Example value: no-example-provided

Description: no-description-provided

can_see_transaction_other_bank_account

Example value: no-example-provided

Description: no-description-provided

can_see_transaction_start_date

Example value: no-example-provided

Description: no-description-provided

can_see_transaction_this_bank_account

Example value: no-example-provided

Description: no-description-provided

can_see_transaction_type

Example value: no-example-provided

Description: no-description-provided

can_see_url

Example value: no-example-provided

Description: no-description-provided

can_see_where_tag

Example value: no-example-provided

Description: no-description-provided

cancelled

Example value: true

Description: no-description-provided

card_attributes

Example value: no-example-provided

Description: no-description-provided

card_description

Example value: no-example-provided

Description: no-description-provided

card_number

Example value: no-example-provided

Description: no-description-provided

cards

Example value: no-example-provided

Description: no-description-provided

category

Example value: no-example-provided

Description: no-description-provided

challenge

Example value: no-example-provided

Description: no-description-provided

challenge_type

Example value: no-example-provided

Description: no-description-provided

channel

Example value: no-example-provided

Description: no-description-provided

charge

Example value: no-example-provided

Description: no-description-provided

charge_policy

Example value: no-example-provided

Description: no-description-provided

checks

Example value: no-example-provided

Description: no-description-provided

city

Example value: no-example-provided

Description: no-description-provided

closing_time

Example value: no-example-provided

Description: no-description-provided

code

Example value: no-example-provided

Description: no-description-provided

collected

Example value: 2020-01-27

Description: no-description-provided

collection_code

Example value: no-example-provided

Description: no-description-provided

comment_id

Example value: no-example-provided

Description: no-description-provided

comments

Example value: no-example-provided

Description: no-description-provided

completed

Example value: 2020-01-27

Description: no-description-provided

connector

Example value: no-example-provided

Description: no-description-provided

connector_name

Example value: no-example-provided

Description: no-description-provided

connector_version

Example value: no-example-provided

Description: no-description-provided

Example value: no-example-provided

Description: no-description-provided

consents

Example value: no-example-provided

Description: no-description-provided

consumers

Example value: no-example-provided

Description: no-description-provided

contact_details

Example value: no-example-provided

Description: no-description-provided

conversion_value

Example value: 100

Description: no-description-provided

corporate_location

Example value: no-example-provided

Description: no-description-provided

count

Example value: no-example-provided

Description: no-description-provided

counterparties

Example value: no-example-provided

Description: no-description-provided

counterparty

Example value: no-example-provided

Description: no-description-provided

country_code

Example value: no-example-provided

Description: no-description-provided

county

Example value: no-example-provided

Description: no-description-provided

created

Example value: no-example-provided

Description: no-description-provided

created_by_user

Example value: no-example-provided

Description: no-description-provided

created_by_user_id

Example value: no-example-provided

Description: no-description-provided

creator

Example value: no-example-provided

Description: no-description-provided

credit_limit

Example value: no-example-provided

Description: no-description-provided

credit_rating

Example value: no-example-provided

Description: no-description-provided

creditoraccount

Example value: no-example-provided

Description: no-description-provided

creditorname

Example value: no-example-provided

Description: no-description-provided

crm_events

Example value: no-example-provided

Description: no-description-provided

current_credit_documentation

Example value: no-example-provided

Description: no-description-provided

current_state

Example value: no-example-provided

Description: no-description-provided

customer

Example value: no-example-provided

Description: no-description-provided

customer_address_id

Example value: no-example-provided

Description: no-description-provided

customer_attributes

Example value: no-example-provided

Description: no-description-provided

customer_name

Example value: no-example-provided

Description: no-description-provided

customer_token

Example value: no-example-provided

Description: no-description-provided

customer_user_id

Example value: no-example-provided

Description: no-description-provided

customers

Example value: no-example-provided

Description: no-description-provided

data.bankid

Example value: no-example-provided

Description: no-description-provided

date_activated

Example value: no-example-provided

Description: no-description-provided

date_added

Example value: no-example-provided

Description: no-description-provided

date_inserted

Example value: no-example-provided

Description: no-description-provided

date_of_application

Example value: 2020-01-27

Description: no-description-provided

debtoraccount

Example value: no-example-provided

Description: no-description-provided

dependants

Example value: no-example-provided

Description: no-description-provided

dependent_endpoints

Example value: no-example-provided

Description: no-description-provided

description

Example value: no-example-provided

Description: no-description-provided

detail

Example value: no-example-provided

Description: no-description-provided

details

Example value: no-example-provided

Description: no-description-provided

developer_email

Example value: no-example-provided

Description: no-description-provided

direct_debit_id

Example value: no-example-provided

Description: no-description-provided

display_name

Example value: no-example-provided

Description: no-description-provided

distribution_channel

Example value: no-example-provided

Description: no-description-provided

dob_of_dependants

Example value: no-example-provided

Description: no-description-provided

document_number

Example value: no-example-provided

Description: no-description-provided

documents

Example value: no-example-provided

Description: no-description-provided

domain

Example value: no-example-provided

Description: no-description-provided

drive_up

Example value: no-example-provided

Description: no-description-provided

driveup

Example value: no-example-provided

Description: no-description-provided

duration

Example value: no-example-provided

Description: no-description-provided

duration_time

Example value: no-example-provided

Description: no-description-provided

e

Example value: no-example-provided

Description: no-description-provided

effective_date

Example value: 2020-01-27

Description: no-description-provided

Example value: no-example-provided

Description: no-description-provided

email_address

Example value: no-example-provided

Description: no-description-provided

enabled

Example value: true

Description: no-description-provided

end_date

Example value: no-example-provided

Description: no-description-provided

energy_source

Example value: no-example-provided

Description: no-description-provided

entitlement_id

Example value: no-example-provided

Description: no-description-provided

entitlement_request_id

Example value: no-example-provided

Description: no-description-provided

entitlement_requests

Example value: no-example-provided

Description: no-description-provided

entitlements

Example value: no-example-provided

Description: no-description-provided

everything

Example value: no-example-provided

Description: no-description-provided

example_inbound_message

Example value: no-example-provided

Description: no-description-provided

example_outbound_message

Example value: no-example-provided

Description: no-description-provided

execution_date

Example value: no-example-provided

Description: no-description-provided

execution_time

Example value: no-example-provided

Description: no-description-provided

face_image

Example value: no-example-provided

Description: no-description-provided

family

Example value: no-example-provided

Description: no-description-provided

field

Example value: no-example-provided

Description: no-description-provided

first_check_number

Example value: no-example-provided

Description: no-description-provided

first_name

Example value: no-example-provided

Description: no-description-provided

free_form

Example value: no-example-provided

Description: no-description-provided

frequency

Example value: no-example-provided

Description: no-description-provided

friday

Example value: no-example-provided

Description: no-description-provided

from

Example value: no-example-provided

Description: no-description-provided

from_currency_code

Example value: no-example-provided

Description: no-description-provided

from_date

Example value: no-example-provided

Description: no-description-provided

from_department

Example value: no-example-provided

Description: no-description-provided

from_person

Example value: no-example-provided

Description: no-description-provided

full_name

Example value: no-example-provided

Description: no-description-provided

function_name

Example value: no-example-provided

Description: no-description-provided

future_date

Example value: no-example-provided

Description: no-description-provided

generate_accountants_view

Example value: no-example-provided

Description: no-description-provided

generate_auditors_view

Example value: no-example-provided

Description: no-description-provided

generate_public_view

Example value: no-example-provided

Description: no-description-provided

glossary_items

Example value: no-example-provided

Description: no-description-provided

group

Example value: no-example-provided

Description: no-description-provided

handle

Example value: no-example-provided

Description: no-description-provided

has_deposit_capability

Example value: true

Description: no-description-provided

hide_metadata_if_alias_used

Example value: no-example-provided

Description: no-description-provided

holder

Example value: no-example-provided

Description: no-description-provided

holders

Example value: no-example-provided

Description: no-description-provided

hosted_at

Example value: no-example-provided

Description: no-description-provided

hosted_by

Example value: no-example-provided

Description: no-description-provided

hours

Example value: no-example-provided

Description: no-description-provided

how

Example value: no-example-provided

Description: no-description-provided

html

Example value: html format content

Description: the content is displayed in HTML format

http_method

Example value: no-example-provided

Description: no-description-provided

http_protocol

Example value: no-example-provided

Description: no-description-provided

id

Example value: no-example-provided

Description: no-description-provided

image_id

Example value: no-example-provided

Description: no-description-provided

image_url

Example value: no-example-provided

Description: no-description-provided

images

Example value: no-example-provided

Description: no-description-provided

implemented_by_partial_function

Example value: no-example-provided

Description: no-description-provided

implemented_in_version

Example value: no-example-provided

Description: no-description-provided

inbound_topic

Example value: no-example-provided

Description: no-description-provided

inboundavroschema

Example value: no-example-provided

Description: no-description-provided

index

Example value: no-example-provided

Description: no-description-provided

instructedamount

Example value: no-example-provided

Description: no-description-provided

inverse_conversion_value

Example value: 50

Description: no-description-provided

invitees

Example value: no-example-provided

Description: no-description-provided

is_accessible

Example value: true

Description: no-description-provided

is_active

Example value: no-example-provided

Description: no-description-provided

is_alias

Example value: no-example-provided

Description: no-description-provided

is_bank_id_exact_match

Example value: no-example-provided

Description: no-description-provided

is_firehose

Example value: no-example-provided

Description: no-description-provided

is_public

Example value: no-example-provided

Description: no-description-provided

is_system

Example value: no-example-provided

Description: no-description-provided

issue_place

Example value: no-example-provided

Description: no-description-provided

items

Example value: no-example-provided

Description: no-description-provided

jsonstring

Example value: no-example-provided

Description: no-description-provided

jwks_uri

Example value: no-example-provided

Description: no-description-provided

jwks_uris

Example value: no-example-provided

Description: no-description-provided

jwt

Example value: no-example-provided

Description: no-description-provided

keys

Example value: no-example-provided

Description: no-description-provided

kid

Example value: no-example-provided

Description: no-description-provided

kind

Example value: no-example-provided

Description: no-description-provided

kty

Example value: no-example-provided

Description: no-description-provided

kyc_check_id

Example value: no-example-provided

Description: no-description-provided

kyc_document

Example value: no-example-provided

Description: no-description-provided

kyc_document_id

Example value: no-example-provided

Description: no-description-provided

kyc_media_id

Example value: no-example-provided

Description: no-description-provided

last_failure_date

Example value: no-example-provided

Description: no-description-provided

last_lock_date

Example value: no-example-provided

Description: no-description-provided

last_name

Example value: no-example-provided

Description: no-description-provided

last_ok_date

Example value: no-example-provided

Description: no-description-provided

latitude

Example value: 38.8951

Description: no-description-provided

license

Example value: no-example-provided

Description: no-description-provided

line1

Example value: no-example-provided

Description: no-description-provided

line2

Example value: no-example-provided

Description: no-description-provided

line3

Example value: no-example-provided

Description: no-description-provided

Example value: no-example-provided

Description: no-description-provided

list

Example value: no-example-provided

Description: no-description-provided

lobby

Example value: no-example-provided

Description: no-description-provided

located_at

Example value: no-example-provided

Description: no-description-provided

location

Example value: no-example-provided

Description: no-description-provided

log_level

Example value: no-example-provided

Description: no-description-provided

Example value: no-example-provided

Description: no-description-provided

longitude

Example value: -77.0364

Description: no-description-provided

markdown

Example value: no-example-provided

Description: no-description-provided

match_all

Example value: no-example-provided

Description: no-description-provided

maximum_response_time

Example value: no-example-provided

Description: no-description-provided

medias

Example value: no-example-provided

Description: no-description-provided

meeting_id

Example value: no-example-provided

Description: no-description-provided

meetings

Example value: no-example-provided

Description: no-description-provided

member_product_code

Example value: no-example-provided

Description: no-description-provided

message

Example value: no-example-provided

Description: no-description-provided

message_docs

Example value: no-example-provided

Description: no-description-provided

message_format

Example value: no-example-provided

Description: no-description-provided

messages

Example value: no-example-provided

Description: no-description-provided

meta

Example value: no-example-provided

Description: no-description-provided

metadata

Example value: no-example-provided

Description: no-description-provided

metadata_view

Example value: no-example-provided

Description: no-description-provided

method_name

Example value: no-example-provided

Description: no-description-provided

method_routing_id

Example value: no-example-provided

Description: no-description-provided

method_routings

Example value: no-example-provided

Description: no-description-provided

metrics

Example value: no-example-provided

Description: no-description-provided

minimum_response_time

Example value: no-example-provided

Description: no-description-provided

mobile_phone

Example value: no-example-provided

Description: no-description-provided

mobile_phone_number

Example value: no-example-provided

Description: no-description-provided

monday

Example value: no-example-provided

Description: no-description-provided

more_info

Example value: no-example-provided

Description: no-description-provided

more_info_url

Example value: no-example-provided

Description: no-description-provided

n

Example value: no-example-provided

Description: no-description-provided

name

Example value: no-example-provided

Description: no-description-provided

narrative

Example value: no-example-provided

Description: no-description-provided

national_identifier

Example value: no-example-provided

Description: no-description-provided

networks

Example value: no-example-provided

Description: no-description-provided

new_balance

Example value: 20

Description: no-description-provided

nickname

Example value: no-example-provided

Description: no-description-provided

nominal_interest1

Example value: no-example-provided

Description: no-description-provided

nominal_interest2

Example value: no-example-provided

Description: no-description-provided

none

Example value: no-example-provided

Description: no-description-provided

number

Example value: no-example-provided

Description: no-description-provided

number_of_checkbooks

Example value: no-example-provided

Description: no-description-provided

ok

Example value: true

Description: no-description-provided

on_hot_list

Example value: false

Description: no-description-provided

open_corporates_url

Example value: no-example-provided

Description: no-description-provided

opening_time

Example value: no-example-provided

Description: no-description-provided

order

Example value: no-example-provided

Description: no-description-provided

order_date

Example value: 2020-01-27

Description: no-description-provided

order_id

Example value: no-example-provided

Description: no-description-provided

orders

Example value: no-example-provided

Description: no-description-provided

organisation

Example value: no-example-provided

Description: no-description-provided

organisation_website

Example value: no-example-provided

Description: no-description-provided

other_account

Example value: no-example-provided

Description: no-description-provided

other_account_id

Example value: no-example-provided

Description: no-description-provided

other_account_routing_address

Example value: no-example-provided

Description: no-description-provided

other_account_routing_scheme

Example value: no-example-provided

Description: no-description-provided

other_account_secondary_routing_address

Example value: no-example-provided

Description: no-description-provided

other_account_secondary_routing_scheme

Example value: no-example-provided

Description: no-description-provided

other_accounts

Example value: no-example-provided

Description: no-description-provided

other_bank_routing_address

Example value: no-example-provided

Description: no-description-provided

other_bank_routing_scheme

Example value: no-example-provided

Description: no-description-provided

other_branch_routing_address

Example value: no-example-provided

Description: no-description-provided

other_branch_routing_scheme

Example value: no-example-provided

Description: no-description-provided

outbound_topic

Example value: no-example-provided

Description: no-description-provided

outboundavroschema

Example value: no-example-provided

Description: no-description-provided

overall_balance

Example value: 10

Description: no-description-provided

overall_balance_date

Example value: 2020-01-27

Description: no-description-provided

owners

Example value: no-example-provided

Description: no-description-provided

parameters

Example value: no-example-provided

Description: no-description-provided

parent_product

Example value: no-example-provided

Description: no-description-provided

parent_product_code

Example value: no-example-provided

Description: no-description-provided

per_day

Example value: no-example-provided

Description: no-description-provided

per_day_call_limit

Example value: no-example-provided

Description: no-description-provided

per_hour

Example value: no-example-provided

Description: no-description-provided

per_hour_call_limit

Example value: no-example-provided

Description: no-description-provided

per_minute

Example value: no-example-provided

Description: no-description-provided

per_minute_call_limit

Example value: no-example-provided

Description: no-description-provided

per_month

Example value: no-example-provided

Description: no-description-provided

per_month_call_limit

Example value: no-example-provided

Description: no-description-provided

per_second

Example value: no-example-provided

Description: no-description-provided

per_second_call_limit

Example value: no-example-provided

Description: no-description-provided

per_week

Example value: no-example-provided

Description: no-description-provided

per_week_call_limit

Example value: no-example-provided

Description: no-description-provided

permissions

Example value: no-example-provided

Description: no-description-provided

phone

Example value: no-example-provided

Description: no-description-provided

phone_number

Example value: no-example-provided

Description: no-description-provided

physical_location

Example value: no-example-provided

Description: no-description-provided

pin_reset

Example value: no-example-provided

Description: no-description-provided

ports

Example value: no-example-provided

Description: no-description-provided

post_code

Example value: no-example-provided

Description: no-description-provided

postcode

Example value: no-example-provided

Description: no-description-provided

posted

Example value: 2020-01-27

Description: no-description-provided

present

Example value: no-example-provided

Description: no-description-provided

private_alias

Example value: no-example-provided

Description: no-description-provided

process

Example value: no-example-provided

Description: no-description-provided

product_attribute_id

Example value: no-example-provided

Description: no-description-provided

product_attributes

Example value: no-example-provided

Description: no-description-provided

product_code

Example value: no-example-provided

Description: no-description-provided

product_collection

Example value: no-example-provided

Description: no-description-provided

products

Example value: no-example-provided

Description: no-description-provided

property

Example value: no-example-provided

Description: no-description-provided

provider

Example value: no-example-provided

Description: no-description-provided

provider_id

Example value: no-example-provided

Description: no-description-provided

public_alias

Example value: no-example-provided

Description: no-description-provided

purpose_id

Example value: no-example-provided

Description: no-description-provided

query

Example value: no-example-provided

Description: no-description-provided

rank_amount1

Example value: no-example-provided

Description: no-description-provided

rank_amount2

Example value: no-example-provided

Description: no-description-provided

reason_requested

Example value: no-example-provided

Description: no-description-provided

reasons

Example value: no-example-provided

Description: no-description-provided

redirect_url

Example value: no-example-provided

Description: no-description-provided

refund

Example value: no-example-provided

Description: no-description-provided

relates_to_kyc_check_id

Example value: no-example-provided

Description: no-description-provided

relates_to_kyc_document_id

Example value: no-example-provided

Description: no-description-provided

remote_data_secret_matched

Example value: no-example-provided

Description: no-description-provided

replacement

Example value: no-example-provided

Description: no-description-provided

request_id

Example value: no-example-provided

Description: no-description-provided

requested_current_rate_amount1

Example value: no-example-provided

Description: no-description-provided

requested_current_rate_amount2

Example value: no-example-provided

Description: no-description-provided

requested_current_valid_end_date

Example value: no-example-provided

Description: no-description-provided

requested_temporary_valid_end_date

Example value: no-example-provided

Description: no-description-provided

require_scopes_for_all_roles

Example value: no-example-provided

Description: no-description-provided

require_scopes_for_listed_roles

Example value: no-example-provided

Description: no-description-provided

requiredfieldinfo

Example value: no-example-provided

Description: no-description-provided

requires_bank_id

Example value: no-example-provided

Description: no-description-provided

reset_in_seconds

Example value: no-example-provided

Description: no-description-provided

reset_password_url

Example value: no-example-provided

Description: no-description-provided

result

Example value: no-example-provided

Description: no-description-provided

revoked

Example value: no-example-provided

Description: no-description-provided

role

Example value: no-example-provided

Description: no-description-provided

role_name

Example value: no-example-provided

Description: no-description-provided

roles

Example value: no-example-provided

Description: no-description-provided

sandbox_tan

Example value: no-example-provided

Description: no-description-provided

satisfied

Example value: true

Description: no-description-provided

saturday

Example value: no-example-provided

Description: no-description-provided

sca_method

Example value: no-example-provided

Description: no-description-provided

scheduled_date

Example value: no-example-provided

Description: no-description-provided

scheme

Example value: no-example-provided

Description: no-description-provided

scope_id

Example value: no-example-provided

Description: no-description-provided

scopes

Example value: no-example-provided

Description: no-description-provided

sepa

Example value: no-example-provided

Description: no-description-provided

sepaB2b

Example value: yes

Description: no-description-provided

sepaCardClearing

Example value: no

Description: no-description-provided

sepaCreditTransfer

Example value: yes

Description: no-description-provided

sepaDirectDebit

Example value: yes

Description: no-description-provided

sepaSddCore

Example value: yes

Description: no-description-provided

service_available

Example value: no-example-provided

Description: no-description-provided

settlement_accounts

Example value: no-example-provided

Description: no-description-provided

shipping_code

Example value: no-example-provided

Description: no-description-provided

short_code

Example value: no-example-provided

Description: no-description-provided

short_name

Example value: no-example-provided

Description: no-description-provided

short_reference

Example value: no-example-provided

Description: no-description-provided

shortcode

Example value: no-example-provided

Description: no-description-provided

sms

Example value: no-example-provided

Description: no-description-provided

staff_name

Example value: no-example-provided

Description: no-description-provided

staff_token

Example value: no-example-provided

Description: no-description-provided

staff_user_id

Example value: no-example-provided

Description: no-description-provided

standing_order_id

Example value: no-example-provided

Description: no-description-provided

state

Example value: no-example-provided

Description: no-description-provided

status

Example value: no-example-provided

Description: no-description-provided

statuses

Example value: no-example-provided

Description: no-description-provided

success

Example value: no-example-provided

Description: no-description-provided

suggested_order

Example value: no-example-provided

Description: no-description-provided

summary

Example value: no-example-provided

Description: no-description-provided

sunday

Example value: no-example-provided

Description: no-description-provided

super_family

Example value: no-example-provided

Description: no-description-provided

swift_bic

Example value: no-example-provided

Description: no-description-provided

tag_id

Example value: no-example-provided

Description: no-description-provided

tags

Example value: no-example-provided

Description: no-description-provided

tax_number

Example value: no-example-provided

Description: no-description-provided

tax_residence

Example value: no-example-provided

Description: no-description-provided

tax_residence_id

Example value: no-example-provided

Description: no-description-provided

technology

Example value: no-example-provided

Description: no-description-provided

temporary_credit_documentation

Example value: no-example-provided

Description: no-description-provided

temporary_requested_current_amount

Example value: no-example-provided

Description: no-description-provided

this_account

Example value: no-example-provided

Description: no-description-provided

this_account_id

Example value: no-example-provided

Description: no-description-provided

this_bank_id

Example value: no-example-provided

Description: no-description-provided

this_view_id

Example value: no-example-provided

Description: no-description-provided

thursday

Example value: no-example-provided

Description: no-description-provided

time_to_live

Example value: no-example-provided

Description: no-description-provided

to

Example value: no-example-provided

Description: no-description-provided

to_counterparty

Example value: no-example-provided

Description: no-description-provided

to_currency_code

Example value: no-example-provided

Description: no-description-provided

to_date

Example value: no-example-provided

Description: no-description-provided

to_sandbox_tan

Example value: no-example-provided

Description: no-description-provided

to_sepa

Example value: no-example-provided

Description: no-description-provided

to_sepa_credit_transfers

Example value: no-example-provided

Description: no-description-provided

to_transfer_to_account

Example value: no-example-provided

Description: no-description-provided

to_transfer_to_atm

Example value: no-example-provided

Description: no-description-provided

to_transfer_to_phone

Example value: no-example-provided

Description: no-description-provided

token

Example value: no-example-provided

Description: no-description-provided

top_apis

Example value: no-example-provided

Description: no-description-provided

top_consumers

Example value: no-example-provided

Description: no-description-provided

transaction_attributes

Example value: no-example-provided

Description: no-description-provided

transaction_ids

Example value: no-example-provided

Description: no-description-provided

transaction_request_types

Example value: no-example-provided

Description: no-description-provided

transaction_requests_with_charges

Example value: no-example-provided

Description: no-description-provided

transaction_types

Example value: no-example-provided

Description: no-description-provided

transactions

Example value: no-example-provided

Description: no-description-provided

transfer_type

Example value: no-example-provided

Description: no-description-provided

trigger_name

Example value: no-example-provided

Description: no-description-provided

ttl_in_seconds

Example value: no-example-provided

Description: no-description-provided

tuesday

Example value: no-example-provided

Description: no-description-provided

type

Example value: no-example-provided

Description: no-description-provided

type_of_lock

Example value: no-example-provided

Description: no-description-provided

use

Example value: no-example-provided

Description: no-description-provided

use_type

Example value: no-example-provided

Description: no-description-provided

user

Example value: no-example-provided

Description: no-description-provided

user_auth_context_id

Example value: no-example-provided

Description: no-description-provided

user_auth_context_update_id

Example value: no-example-provided

Description: no-description-provided

user_auth_contexts

Example value: no-example-provided

Description: no-description-provided

Example value: no-example-provided

Description: no-description-provided

Example value: no-example-provided

Description: no-description-provided

users

Example value: no-example-provided

Description: no-description-provided

valid_from

Example value: 2020-01-27

Description: no-description-provided

verb

Example value: no-example-provided

Description: no-description-provided

version

Example value: no-example-provided

Description: no-description-provided

version_status

Example value: no-example-provided

Description: no-description-provided

view

Example value: no-example-provided

Description: no-description-provided

view.description

Example value: This view is for the owner for the account.

Description: A description for this view.

view.id

Example value: owner

Description: A viewId can be owner, accountant, public ....

view.name

Example value: Owner

Description: A viewName can be Owner, Accountant, Public ....

views

Example value: no-example-provided

Description: no-description-provided

views_available

Example value: no-example-provided

Description: no-description-provided

views_basic

Example value: no-example-provided

Description: no-description-provided

warehouse

Example value: no-example-provided

Description: no-description-provided

web_hooks

Example value: no-example-provided

Description: no-description-provided

web_ui_props_id

Example value: no-example-provided

Description: no-description-provided

website

Example value: no-example-provided

Description: no-description-provided

webui_props

Example value: no-example-provided

Description: no-description-provided

wednesday

Example value: no-example-provided

Description: no-description-provided

when

Example value: 2020-01-27

Description: no-description-provided

where

Example value: no-example-provided

Description: no-description-provided

which_alias_to_use

Example value: no-example-provided

Description: no-description-provided