{"swagger":"2.0","info":{"title":"Open Bank Project API","description":"An Open Source API for Banks. (c) TESOBE GmbH. 2011 - 2026. Licensed under the AGPL and commercial licences.","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v5.1.0"},"host":"obp-api-sandbox.nmbbank.co.tz","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"Direct Login authentication. POST to /obp/v6.0.0/my/logins/direct with header 'DirectLogin: username=YOUR_USERNAME, password=YOUR_PASSWORD, consumer_key=YOUR_CONSUMER_KEY' to obtain a token. Then use header 'DirectLogin: token=YOUR_TOKEN' on subsequent requests. See the OpenAPI 3.1 spec for full details.","in":"header","name":"DirectLogin"},"gatewayLogin":{"type":"apiKey","description":"Gateway Login authentication. The gateway sends a JWT in the Authorization header signed with a pre-shared secret. See the OpenAPI 3.1 spec for full details.","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/obp/v5.1.0/banks/FIREHOSE_BANK_ID/firehose/accounts/FIREHOSE_ACCOUNT_ID/views/FIREHOSE_VIEW_ID/transactions":{"get":{"tags":["Transaction","Account-Firehose","Transaction-Firehose","FirehoseData"],"summary":"Get Firehose Transactions for Account","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get Transactions for an Account that has a firehose View.

Allows bulk access to an account's transactions.
User must have the CanUseFirehoseAtAnyBank Role

To find ACCOUNT_IDs, use the getFirehoseAccountsAtOneBank call.

For VIEW_ID try 'owner'

Possible custom url parameters for pagination:

eg1:?limit=100&offset=0

URL encoding: query parameter values containing &, =, +, #, %, or spaces must be URL-encoded (e.g. + → %2B, space → %20). Most other characters (including @ in emails) are safe unencoded, but encoding is always permitted.

eg2:?limit=100&offset=0&sort_direction=ASC

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.

eg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

FIREHOSE_ACCOUNT_ID: FIREHOSE_ACCOUNT_ID

FIREHOSE_BANK_ID: FIREHOSE_BANK_ID

FIREHOSE_VIEW_ID: FIREHOSE_VIEW_ID

JSON response body fields:

URL: http://www.example.com/id-docs/123/image.png

account_routings:

address:

amount: 10.12

bank_routing:

comments:

completed: 2020-01-27

corporate_location: 10

currency: EUR

date: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

details:

display_name:

holder:

holders:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

image_URL:

images:

is_alias:

label: My Account

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

narrative:

new_balance: 20

open_corporates_URL:

other_account:

physical_location:

posted: 2020-01-27

private_alias:

provider: ETHEREUM

public_alias:

scheme: OBP

tags: Create-My-User

this_account:

transaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

transaction_attributes:

transactions:

type:

user:

value: 5987953

where:

","operationId":"OBPv3.0.0-getFirehoseTransactionsForBankAccount","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/TransactionsJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/banks/FIREHOSE_BANK_ID/firehose/accounts/views/FIREHOSE_VIEW_ID":{"get":{"tags":["Account","Account-Firehose","FirehoseData"],"summary":"Get Firehose Accounts at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get all Accounts at a Bank.

This endpoint allows bulk access to all accounts at the specified bank.

Requires the CanUseFirehoseAtAnyBank Role or CanUseAccountFirehose Role

Returns all accounts at the bank. The VIEW_ID parameter determines what account data fields are visible according to the view's permissions.

The view specified must have is_firehose = true

For VIEW_ID try 'owner' or 'firehose'

Optional request parameters for filtering by account attributes:
URL params example:
/banks/some-bank-id/firehose/accounts/views/owner?limit=50&offset=1

To invalidate browser cache, add timestamp query parameter as follows (the parameter name must be _timestamp_):
URL params example:
/banks/some-bank-id/firehose/accounts/views/owner?limit=50&offset=1&_timestamp_=1596762180358

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

FIREHOSE_BANK_ID: FIREHOSE_BANK_ID

FIREHOSE_VIEW_ID: FIREHOSE_VIEW_ID

JSON response body fields:

account_routings:

account_rules:

accounts:

address:

amount: 10.12

balance: 10

bank_id: gh.29.uk

currency: EUR

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

number:

owners:

product_code: 1234BW

provider: ETHEREUM

scheme: OBP

value: 5987953

account_attributes:

","operationId":"OBPv4.0.0-getFirehoseAccountsAtOneBank","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ModeratedFirehoseAccountsJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}}},"/obp/v5.1.0/banks/FIREHOSE_BANK_ID/firehose/customers":{"get":{"tags":["Customer","FirehoseData"],"summary":"Get Firehose Customers","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

Get Customers that has a firehose View.

Allows bulk access to customers.
User must have the CanUseFirehoseAtAnyBank Role

Possible custom url parameters for pagination:

eg1:?limit=100&offset=0

URL encoding: query parameter values containing &, =, +, #, %, or spaces must be URL-encoded (e.g. + → %2B, space → %20). Most other characters (including @ in emails) are safe unencoded, but encoding is always permitted.

eg2:?limit=100&offset=0&sort_direction=ASC

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.

eg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

FIREHOSE_BANK_ID: FIREHOSE_BANK_ID

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

currency: EUR

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

customers:

date: 2020-01-27

date_of_birth: 2018-03-09

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2025-05-26T19:24:06.145Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

rating:

relationship_status: single

source:

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

","operationId":"OBPv3.1.0-getFirehoseCustomers","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJSONs"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/management/banks/{BANK_ID}/fast-firehose/accounts":{"get":{"tags":["Account","Account-Firehose","FirehoseData"],"summary":"Get Fast Firehose Accounts at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"

This endpoint allows bulk access to accounts.

optional pagination parameters for filter with accounts

Possible custom url parameters for pagination:

eg1:?limit=100&offset=0

URL encoding: query parameter values containing &, =, +, #, %, or spaces must be URL-encoded (e.g. + → %2B, space → %20). Most other characters (including @ in emails) are safe unencoded, but encoding is always permitted.

eg2:?limit=100&offset=0&sort_direction=ASC

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

account_attributes:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

account_routings:

accounts:

amount: 10.12

balance: 10

bank_id: gh.29.uk

code: 125

currency: EUR

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

number:

owners:

product_code: 1234BW

provider: ETHEREUM

type:

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

user_name: felixsmith

value: 5987953

","operationId":"OBPv4.0.0-getFastFirehoseAccountsAtOneBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/FastFirehoseAccountsJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}}}},"definitions":{"ErrorAuthenticatedUserIsRequired":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"ErrorBankNotFound":{"properties":{"message":{"type":"string","example":"OBP-30001: Bank not found. Please specify a valid value for BANK_ID."}}},"TransactionsJsonV300":{"required":["transactions"],"properties":{"transactions":{"type":"array","items":{"$ref":"#/definitions/TransactionJsonV300"}}}},"CustomerJSONs":{"required":["customers"],"properties":{"customers":{"type":"array","items":{"$ref":"#/definitions/CustomerJsonV210"}}}},"ModeratedFirehoseAccountsJsonV400":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/ModeratedFirehoseAccountJsonV400"}}}},"FastFirehoseAccountsJsonV400":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/FastFirehoseAccountJsonV400"}}}},"BankRoutingJsonV121":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"OBP"},"address":{"type":"string","example":"gh.29.uk"}}},"AccountRoutingJsonV121":{"required":["scheme","address"],"properties":{"scheme":{"type":"string","example":"OBP"},"address":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}}},"AccountHolderJSON":{"required":["name","is_alias"],"properties":{"name":{"type":"string","example":"OBP"},"is_alias":{"type":"boolean","example":"true"}}},"ThisAccountJsonV300":{"required":["id","bank_routing","account_routings","holders"],"properties":{"id":{"type":"string","example":"String"},"bank_routing":{"$ref":"#/definitions/BankRoutingJsonV121"},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"holders":{"type":"array","items":{"$ref":"#/definitions/AccountHolderJSON"}}}},"UserJSONV121":{"required":["id","provider","display_name"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"provider":{"type":"string","example":"http://127.0.0.1:8080"},"display_name":{"type":"string","example":"OBP"}}},"LocationJSONV121":{"required":["latitude","longitude","date","user"],"properties":{"latitude":{"type":"number","format":"double","example":"1.231"},"longitude":{"type":"number","format":"double","example":"1.231"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"OtherAccountMetadataJSON":{"required":["public_alias","image_URL","physical_location","private_alias","URL","more_info","corporate_location","open_corporates_URL"],"properties":{"public_alias":{"type":"string","example":"NONE"},"image_URL":{"type":"string","example":"www.openbankproject.com"},"physical_location":{"$ref":"#/definitions/LocationJSONV121"},"private_alias":{"type":"string","example":"NONE"},"URL":{"type":"string","example":"www.openbankproject.com"},"more_info":{"type":"string","example":"www.openbankproject.com"},"corporate_location":{"$ref":"#/definitions/LocationJSONV121"},"open_corporates_URL":{"type":"string","example":"www.openbankproject.com"}}},"OtherAccountJsonV300":{"required":["account_routings","holder","id","metadata","bank_routing"],"properties":{"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"holder":{"$ref":"#/definitions/AccountHolderJSON"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"metadata":{"$ref":"#/definitions/OtherAccountMetadataJSON"},"bank_routing":{"$ref":"#/definitions/BankRoutingJsonV121"}}},"AmountOfMoneyJsonV121":{"required":["currency","amount"],"properties":{"currency":{"type":"string","example":"EUR"},"amount":{"type":"string","example":"0"}}},"TransactionDetailsJSON":{"required":["new_balance","description","completed","type","value","posted"],"properties":{"new_balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"description":{"type":"string","example":"this is for family"},"completed":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"type":{"type":"string","example":"AC"},"value":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"posted":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"TransactionCommentJSON":{"required":["id","value","date","user"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"value":{"type":"string","example":"OBP"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"TransactionTagJSON":{"required":["id","value","date","user"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"value":{"type":"string","example":"OBP"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"TransactionImageJSON":{"required":["URL","label","id","date","user"],"properties":{"URL":{"type":"string","example":"www.openbankproject.com"},"label":{"type":"string","example":"NONE"},"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"user":{"$ref":"#/definitions/UserJSONV121"}}},"TransactionMetadataJSON":{"required":["narrative","tags","where","images","comments"],"properties":{"narrative":{"type":"string","example":"NONE"},"tags":{"type":"array","items":{"$ref":"#/definitions/TransactionTagJSON"}},"where":{"$ref":"#/definitions/LocationJSONV121"},"images":{"type":"array","items":{"$ref":"#/definitions/TransactionImageJSON"}},"comments":{"type":"array","items":{"$ref":"#/definitions/TransactionCommentJSON"}}}},"TransactionAttributeResponseJson":{"required":["transaction_attribute_id","name","type","value"],"properties":{"transaction_attribute_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"name":{"type":"string","example":"HOUSE_RENT"},"type":{"type":"string","example":"DATE_WITH_DAY"},"value":{"type":"string","example":"123456789"}}},"TransactionJsonV300":{"required":["this_account","id","details","metadata","other_account","transaction_attributes"],"properties":{"this_account":{"$ref":"#/definitions/ThisAccountJsonV300"},"id":{"type":"string","example":"String"},"details":{"$ref":"#/definitions/TransactionDetailsJSON"},"metadata":{"$ref":"#/definitions/TransactionMetadataJSON"},"other_account":{"$ref":"#/definitions/OtherAccountJsonV300"},"transaction_attributes":{"type":"array","items":{"$ref":"#/definitions/TransactionAttributeResponseJson"}}}},"CustomerFaceImageJson":{"required":["url","date"],"properties":{"url":{"type":"string","example":"www.openbankproject"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"CustomerCreditRatingJSON":{"required":["rating","source"],"properties":{"rating":{"type":"string","example":"OBP"},"source":{"type":"string","example":"OBP"}}},"CustomerJsonV210":{"required":["customer_id","email","mobile_phone_number","customer_number","highest_education_attained","dob_of_dependants","bank_id","date_of_birth","last_ok_date","employment_status","legal_name","face_image","dependants","relationship_status","kyc_status"],"properties":{"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"email":{"type":"string","example":"felixsmith@example.com"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"customer_number":{"type":"string","example":"5987953"},"highest_education_attained":{"type":"string","example":"Master"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date"}},"bank_id":{"type":"string","example":"gh.29.uk"},"date_of_birth":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"credit_rating":{"$ref":"#/definitions/CustomerCreditRatingJSON"},"last_ok_date":{"type":"string","format":"date","example":"2025-05-26T22:24:07Z"},"employment_status":{"type":"string","example":"worker"},"legal_name":{"type":"string","example":"Eveline Tripman"},"credit_limit":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"1"},"relationship_status":{"type":"string","example":"single"},"kyc_status":{"type":"boolean","example":"false"}}},"AccountRuleJsonV300":{"required":["scheme","value"],"properties":{"scheme":{"type":"string","example":"OVERDRAFT"},"value":{"type":"string","example":"10"}}},"ModeratedFirehoseAccountJsonV400":{"required":["number","account_routings","label","owners","balance","product_code","bank_id","id","account_rules"],"properties":{"number":{"type":"string","example":""},"account_attributes":{"type":"array","items":{"$ref":"#/definitions/AccountAttributeResponseJson"}},"account_routings":{"type":"array","items":{"$ref":"#/definitions/AccountRoutingJsonV121"}},"label":{"type":"string","example":"My Account"},"owners":{"type":"array","items":{"$ref":"#/definitions/UserJSONV121"}},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"product_code":{"type":"string","example":"1234BW"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"account_rules":{"type":"array","items":{"$ref":"#/definitions/AccountRuleJsonV300"}}}},"FastFirehoseOwners":{"required":["user_id","provider","user_name"],"properties":{"user_id":{"type":"string","example":"b27327a2-a822-41e5-a909-0150da688939"},"provider":{"type":"string","example":"https://finx22openplatform.fintech-galaxy.com,user_name:synth_user_1_54891"},"user_name":{"type":"string","example":""}}},"FastFirehoseRoutings":{"required":["bank_id","account_id"],"properties":{"bank_id":{"type":"string","example":"bisb.com"},"account_id":{"type":"string","example":"c590e38e-847c-466f-9a62-f2ad67daf106"}}},"FastFirehoseAttributes":{"required":["type","code","value"],"properties":{"type":{"type":"string","example":"INTEGER"},"code":{"type":"string","example":"Loan1"},"value":{"type":"string","example":"0"}}},"FastFirehoseAccountJsonV400":{"required":["number","account_attributes","account_routings","label","owners","balance","product_code","bank_id","id"],"properties":{"number":{"type":"string","example":""},"account_attributes":{"type":"array","items":{"$ref":"#/definitions/FastFirehoseAttributes"}},"account_routings":{"type":"array","items":{"$ref":"#/definitions/FastFirehoseRoutings"}},"label":{"type":"string","example":"My Account"},"owners":{"type":"array","items":{"$ref":"#/definitions/FastFirehoseOwners"}},"balance":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"product_code":{"type":"string","example":"1234BW"},"bank_id":{"type":"string","example":"gh.29.uk"},"id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}}}}}