API Explorer

All OBP APIs v3.1.0 filtered by tag: API, API-Role, API-Metrics, API-Documentation (30)

Bank

Accounts

Views

Counterparties

Transactions

Get API Configuration

Returns information about:

  • API Config
  • Akka ports
  • Elastic search ports
  • Cached function
Typical Successful Response:

								
									
{ "akka":{ "ports":[{ "property":"default", "value":"8080" }], "log_level":"Debug" }, "elastic_search":{ "metrics":[{ "property":"String", "value":"Mapper" }], "warehouse":[{ "property":"String", "value":"ElasticSearch" }] }, "cache":[{ "function_name":"getBanks", "ttl_in_seconds":5 }] }
Required Roles:
  • CanGetConfig - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implmented in 2_2_0 by config

Get API Info (root)

Returns information about:

  • API version
  • Hosted by information
  • Git Commit
Typical Successful Response:

								
									
{ "version":"String", "version_status":"String", "git_commit":"String", "connector":"String", "hosted_by":{ "organisation":"String", "email":"String", "phone":"String", "organisation_website":"String" }, "akka":{ "remote_data_secret_matched":true } }
Possible Errors:
  • OBP-50000: Unknown Error.
  • no connector set
Implmented in 1_2_1 by root

Get Adapter Info

Get basic information about the Adapter listening on behalf of this bank.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "name":"String", "version":"String", "git_commit":"String", "date":"2013-01-21T23:08:00Z" }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by getAdapter

Enable or Disable Consumers

Enable/Disable a Consumer specified by CONSUMER_ID.

Typical Successful Response:

								
									
{ "enabled":false }
Required Roles:
  • CanEnableConsumers - Please login to request this Role
  • CanDisableConsumers - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implmented in 2_1_0 by enableDisableConsumers

Get Consumer

Get the Consumer specified by CONSUMER_ID.

Typical Successful Response:

								
									
{ "consumer_id":1213, "app_name":"SOFI", "app_type":"Web", "description":"Account Management", "developer_email":"contact@tesobe.com", "redirect_url":"www.openbankproject.com", "created_by_user_id":"123213", "created_by_user":{ "user_id":"123", "email":"contact@tesobe.com", "provider_id":"obp", "provider":"obp", "username":"TESOBE" }, "enabled":true, "created":"2017-09-19T00:00:00Z" }
Required Roles:
  • CanGetConsumers - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
  • OBP-50000: Unknown Error.
Implmented in 2_1_0 by getConsumer

Get Consumers

Get the all Consumers.

Typical Successful Response:

								
									
{ "list":[{ "consumer_id":1213, "app_name":"SOFI", "app_type":"Web", "description":"Account Management", "developer_email":"contact@tesobe.com", "redirect_url":"www.openbankproject.com", "created_by_user_id":"123213", "created_by_user":{ "user_id":"123", "email":"contact@tesobe.com", "provider_id":"obp", "provider":"obp", "username":"TESOBE" }, "enabled":true, "created":"2017-09-19T00:00:00Z" }] }
Required Roles:
  • CanGetConsumers - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implmented in 2_1_0 by getConsumers

Update Consumer RedirectUrl

Update an existing redirectUrl for a Consumer specified by CONSUMER_ID.

CONSUMER_ID can be obtained after you register the application.

Or use the endpoint 'Get Consumers' to get it

Typical Successful Response:

								
									
{ "consumer_id":1213, "app_name":"SOFI", "app_type":"Web", "description":"Account Management", "developer_email":"contact@tesobe.com", "redirect_url":"www.openbankproject.com", "created_by_user_id":"123213", "created_by_user":{ "user_id":"123", "email":"contact@tesobe.com", "provider_id":"obp", "provider":"obp", "username":"TESOBE" }, "enabled":true, "created":"2017-09-19T00:00:00Z" }
Required Roles:
  • CanUpdateConsumerRedirectUrl - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implmented in 2_1_0 by updateConsumerRedirectUrl

Get API Glossary

Returns the glossary of the API

Typical Successful Response:

								
									
{ "glossary_items":[{ "title":"Title ", "description":{ "markdown":"\nDescription.\n\nGoes here..\n ", "html":"<p>Description.</p>\n<p>Goes here..</p>" } }] }
Possible Errors:
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by glossary

Get Message Docs

These message docs provide example messages sent by OBP to the (Kafka) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes. Integrators can use these messages to build Adapters that provide core banking services to OBP.

CONNECTOR: kafka_vJuneYellow2017, kafka_vJune2017 , kafka_vMar2017 or ...

Typical Successful Response:

								
									
{ "messageDocs":[{ "process":"getBanks", "message_format":"KafkaV2017", "description":"get Banks", "example_outbound_message":{ "jsonString":"{}" }, "example_inbound_message":{ "jsonString":"{}" }, "outboundAvroSchema":{ "jsonString":"{}" }, "inboundAvroSchema":{ "jsonString":"{}" } }] }
Possible Errors:
  • OBP-50000: Unknown Error.
Implmented in 2_2_0 by getMessageDocs

Get Resource Docs.

Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.

This is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.

This endpoint is used by OBP API Explorer to display and work with the API documentation.

Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank

You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics

For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.

  • operation_id is concatenation of "v", version and function and should be unique (used for DOM element IDs etc. maybe used to link to source code)
  • version references the version that the API call is defined in.
  • function is the (scala) partial function that implements this endpoint. It is unique per version of the API.
  • request_url is empty for the root call, else the path.
  • summary is a short description inline with the swagger terminology.
  • description may contain html markup (generated from markdown on the server).
Typical Successful Response:

								
									
{ "jsonString":"{}" }
Possible Errors:
  • OBP-50000: Unknown Error.
Implmented in 1_4_0 by getResourceDocsObp

Get Swagger documentation

Returns documentation about the RESTful resources on this server in Swagger format.

API_VERSION is the version you want documentation about e.g. v3.0.0

You may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank

(All endpoints are given one or more tags which for used in grouping)

You may filter this endpoint using the 'functions' url parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics

(Each endpoint is implemented in the OBP Scala code by a 'function')

See the Resource Doc endpoint for more information.

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Possible Errors:
  • OBP-50000: Unknown Error.
Implmented in 1_4_0 by getResourceDocsSwagger

Get Connector Metrics

Get the all metrics

require CanGetConnectorMetrics role

Filters Part 1.*filtering* (no wilde cards etc.) parameters to GET /management/connector/metrics

Should be able to filter on the following metrics fields

eg: /management/connector/metrics?from_date=2017-09-19&to_date=2017-09-19&limit=50&offset=2

1 from_date (defaults to one week before current date): eg:from_date=2017-09-19

2 to_date (defaults to current date) eg:to_date=2017-09-19

3 limit (for pagination: defaults to 1000) eg:limit=2000

4 offset (for pagination: zero index, defaults to 0) eg: offset=10

eg: /management/connector/metrics?from_date=2017-09-19&to_date=2017-09-19&limit=100&offset=300

Other filters:

5 connector_name (if null ignore)

6 function_name (if null ignore)

7 correlation_id (if null ignore)

Typical Successful Response:

								
									
{ "metrics":[{ "connector_name":"mapper", "function_name":"getBanks", "correlation_id":"12345", "date":"2017-09-19T00:00:00Z", "duration":1000 }] }
Required Roles:
  • CanGetConnectorMetrics - Please login to request this Role
Possible Errors:
  • OBP-10005: Invalid Date Format. Could not convert value to a Date.
  • OBP-50000: Unknown Error.
Implmented in 2_2_0 by getConnectorMetrics

Get Metrics

Get the all metrics

require CanReadMetrics role

Filters Part 1.*filtering* (no wilde cards etc.) parameters to GET /management/metrics

Should be able to filter on the following metrics fields

eg: /management/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=50&offset=2

1 from_date (defaults to one week before current date): eg:from_date=2017-09-19T02:31:05.000Z

2 to_date (defaults to current date) eg:to_date=2017-09-19T02:31:05.000Z

3 limit (for pagination: defaults to 50) eg:limit=200

4 offset (for pagination: zero index, defaults to 0) eg: offset=10

5 sort_by (defaults to date field) eg: sort_by=date possible values: "url", "date", "user_name", "app_name", "developer_email", "implemented_by_partial_function", "implemented_in_version", "consumer_id", "verb"

6 direction (defaults to date desc) eg: direction=desc

eg: /management/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=10000&offset=0&anon=false&app_name=TeatApp&implemented_in_version=v2.1.0&verb=POST&user_id=c7b6cb47-cb96-4441-8801-35b57456753a&user_name=susan.uk.29@example.com&consumer_id=78

Other filters:

7 consumer_id (if null ignore)

8 user_id (if null ignore)

9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)

10 url (if null ignore), note: can not contain '&'.

11 app_name (if null ignore)

12 implemented_by_partial_function (if null ignore),

13 implemented_in_version (if null ignore)

14 verb (if null ignore)

15 correlation_id (if null ignore)

16 duration (if null ignore) non digit chars will be silently omitted

Typical Successful Response:

								
									
{ "metrics":[{ "user_id":"134", "url":"www.openbankproject.com", "date":"2017-09-19T00:00:00Z", "user_name":"OBP", "app_name":"SOFI", "developer_email":"contact@tesobe.ocm", "implemented_by_partial_function":"getBanks", "implemented_in_version":"v210", "consumer_id":"123", "verb":"get", "correlation_id":"v8ho6h5ivel3uq7a5zcnv0w1", "duration":39 }] }
Required Roles:
  • CanReadMetrics - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implmented in 2_1_0 by getMetrics

Search API Metrics via Elasticsearch.

Search the API calls made to this API instance via Elastic Search.

Login is required.

CanSearchMetrics entitlement is required to search metrics data.

parameters:

esType - elasticsearch type

simple query:

q - plain_text_query

df - default field to search

sort - field to sort on

size - number of hits returned, default 10

from - show hits starting from

json query:

source - JSON_query_(URL-escaped)

example usage:

/search/metrics/q=findThis

or:

/search/metrics/source={"query":{"query_string":{"query":"findThis"}}}

Note!!

The whole JSON query string MUST be URL-encoded:

  • For { use %7B
  • For } use %7D
  • For : use %3A
  • For " use %22

etc..

Only q, source and esType are passed to Elastic

Elastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html

Elastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanSearchMetrics - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implmented in 2_0_0 by elasticSearchMetrics

Add Entitlement Request for a Logged User.

Create Entitlement Request.

Any logged in User can use this endpoint to request an Entitlement

Entitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)

For a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""

For a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"

Authentication is Mandatory

Typical Successful Response:

								
									
{ "entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "user":{ "user_id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "email":"robert.x.0.gh@example.com", "provider_id":"OBP", "provider":"OBP", "username":"robert.x.0.gh", "entitlements":{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"gh.29.uk" }] } }, "role_name":"CanQueryOtherUser", "bank_id":"gh.29.uk", "created":"2017-09-19T00:00:00Z" }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20005: User not found. Please specify a valid value for USER_ID.
  • OBP-10001: Incorrect json format.
  • OBP-10007: Incorrect Role name:
  • OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.
  • OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.
  • OBP-30214: Entitlement Request already exists for the user.
  • OBP-30217: Entitlement Request cannot be added.
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by addEntitlementRequest

Add Entitlement for a User.

Create Entitlement. Grant Role to User.

Entitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)

For a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""

For a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"

Authentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file.

Typical Successful Response:

								
									
{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"gh.29.uk" }
Required Roles:
  • CanCreateEntitlementAtOneBank - Please login to request this Role
  • CanCreateEntitlementAtAnyBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20005: User not found. Please specify a valid value for USER_ID.
  • OBP-10001: Incorrect json format.
  • OBP-10007: Incorrect Role name:
  • OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.
  • OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.
  • OBP-30216: Entitlement already exists for the user.
  • OBP-50000: Unknown Error.
Implmented in 2_0_0 by addEntitlement

Add Scope for a Consumer.

Create Scope. Grant Role to Consumer.

Scopes are used to grant System or Bank level roles to the Consumer (App). (For Account level privileges, see Views)

For a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""

For a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"

Typical Successful Response:

								
									
{ "scope_id":"88625da4-a671-435e-9d24-e5b6e5cc404f", "role_name":"CanGetEntitlementsForAnyUserAtOneBank", "bank_id":"gh.29.uk" }
Required Roles:
  • CanCreateScopeAtOneBank - Please login to request this Role
  • CanCreateScopeAtAnyBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20024: Consumer not found. Please specify a valid value for CONSUMER_ID.
  • OBP-10001: Incorrect json format.
  • OBP-10007: Incorrect Role name:
  • OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.
  • OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.
  • OBP-30216: Entitlement already exists for the user.
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by addScope

Delete Consumer Scope

Delete Consumer Scope specified by SCOPE_ID for an consumer specified by CONSUMER_ID

Authentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file.

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Logged user is not super admin!
  • OBP-30212: EntitlementId not found
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by deleteScope

Delete Entitlement

Delete Entitlement specified by ENTITLEMENT_ID for an user specified by USER_ID

Authentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file.

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Logged user is not super admin!
  • OBP-30212: EntitlementId not found
  • OBP-50000: Unknown Error.
Implmented in 2_0_0 by deleteEntitlement

Delete Entitlement Request

Delete the Entitlement Request specified by ENTITLEMENT_REQUEST_ID for a user specified by USER_ID

Authentication is Mandatory

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanDeleteEntitlementRequestsAtAnyBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Logged user is not super admin!
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by deleteEntitlementRequest

Get Entitlement Requests for a User.

Get Entitlement Requests for a User.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "entitlement_requests":[{ "entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "user":{ "user_id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "email":"robert.x.0.gh@example.com", "provider_id":"OBP", "provider":"OBP", "username":"robert.x.0.gh", "entitlements":{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"gh.29.uk" }] } }, "role_name":"CanQueryOtherUser", "bank_id":"gh.29.uk", "created":"2017-09-19T00:00:00Z" }] }
Required Roles:
  • CanGetEntitlementRequestsAtAnyBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Logged user is not super admin!
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by getEntitlementRequests

Get Entitlement Requests for the current User.

Get Entitlement Requests for the current User.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "entitlement_requests":[{ "entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "user":{ "user_id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "email":"robert.x.0.gh@example.com", "provider_id":"OBP", "provider":"OBP", "username":"robert.x.0.gh", "entitlements":{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"gh.29.uk" }] } }, "role_name":"CanQueryOtherUser", "bank_id":"gh.29.uk", "created":"2017-09-19T00:00:00Z" }] }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Logged user is not super admin!
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by getEntitlementRequestsForCurrentUser

Get Entitlements for User

Authentication is Mandatory

Typical Successful Response:

								
									
{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"gh.29.uk" }] }
Required Roles:
  • CanGetEntitlementsForAnyUserAtAnyBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implmented in 2_0_0 by getEntitlements

Get Entitlements for User at Bank.

Get Entitlements specified by BANK_ID and USER_ID

Authentication is Mandatory

Typical Successful Response:

								
									
{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"gh.29.uk" }] }
Required Roles:
  • CanGetEntitlementsForAnyUserAtOneBank - Please login to request this Role
  • CanGetEntitlementsForAnyUserAtAnyBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implmented in 2_1_0 by getEntitlementsByBankAndUser

Get Entitlements for the current User.

Get Entitlements for the current User.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"gh.29.uk" }] }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Logged user is not super admin!
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by getEntitlementsForCurrentUser

Get Roles

Returns all available roles

Authentication is Mandatory

Typical Successful Response:

								
									
{ "roles":[{ "role":"eBranch", "requires_bank_id":true }] }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implmented in 2_1_0 by getRoles

Get Scopes for Consumer

Get all the scopes for an consumer specified by CONSUMER_ID

Authentication is Mandatory

Typical Successful Response:

								
									
{ "list":[{ "scope_id":"88625da4-a671-435e-9d24-e5b6e5cc404f", "role_name":"CanGetEntitlementsForAnyUserAtOneBank", "bank_id":"gh.29.uk" }] }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Logged user is not super admin!
  • OBP-30212: EntitlementId not found
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by getScopes

Get all Entitlement Requests

Get all Entitlement Requests

Authentication is Mandatory

Typical Successful Response:

								
									
{ "entitlement_requests":[{ "entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "user":{ "user_id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "email":"robert.x.0.gh@example.com", "provider_id":"OBP", "provider":"OBP", "username":"robert.x.0.gh", "entitlements":{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"gh.29.uk" }] } }, "role_name":"CanQueryOtherUser", "bank_id":"gh.29.uk", "created":"2017-09-19T00:00:00Z" }] }
Required Roles:
  • CanGetEntitlementRequestsAtAnyBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Logged user is not super admin!
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by getAllEntitlementRequests

Get all Entitlements

Login is required.

Typical Successful Response:

								
									
{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"gh.29.uk" }] }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Logged user is not super admin!
  • OBP-50000: Unknown Error.
Implmented in 2_0_0 by getAllEntitlements

Create sandbox

Import bulk data into the sandbox (Authenticated access).

This call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.

The user needs to have CanCreateSandbox entitlement.

Note: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.

An example of an import set of data (json) can be found here Authentication is Mandatory

Typical Successful Response:

								
									
{ "success":"Success" }
Required Roles:
  • CanCreateSandbox - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-00002: Data import is disabled for this API instance.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implmented in 2_1_0 by sandboxDataImport