API Explorer

⯆

API Explorer

My Collections

API
- The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeably
  More...
- Get API Info (root)
Account
- The thing that tokens of value (money) come in and out of. An account has one or more `owners` which
  More...
- Create Account
- Create View
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts at Bank
- Get Accounts at Bank (Private)
- Get Accounts at all Banks (Private)
- Get all Accounts at all Banks
- Get private accounts at one bank
- Update Account Label
- Update View
Account Public
Bank
- A Bank (aka Space) represents a financial institution, brand or organizational unit under which res
  More...
- Get Bank
- Get Bank ATMS
- Get Bank Products
- Get Banks
- Get Transaction Types at Bank
Branch
- Get Bank Branches
Card
Counterparty
Counterparty Metadata
Customer
- The legal entity that has the relationship to the bank. Customers are linked to Users via `User Cus
  More...
- Create Customer
- Create Customer Social Media Handle
- Create User Customer Link
- Get CRM Events
- Get Customer Social Media Handles
- Get customer for logged in user
Customer Message
Data Warehouse
- Search Warehouse Data Via Elasticsearch
Documentation
Dynamic Resource Doc
- A test endpoint
KYC
Metric
- Search API Metrics via Elasticsearch
Person
- Get all customers for logged in user
Role
Transaction
- Transactions are records of successful movements of value into or out of an `Account`. OBP Transac
  More...
- Get Other Account of Transaction
- Get Transaction by Id
- Get Transactions for Account (Core)
- Get Transactions for Account (Full)
Transaction Metadata
Transaction Request
- Get Transaction Request Types for Account
User
- The entity that accesses the API with a login / authorisation token and has access to zero or more
  More...
- Create User
- Get User (Current)
- Get Users by Email Address
View Custom

v2.0.0 (112 APIs)

API Host: https://obp-api-sandbox.nmbbank.co.tz

Create Customer

Add a customer linked to the user specified by user_id
The Customer resource stores the customer number, legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc.
This call may require additional permissions/role in the future.
For now the authenticated user can create at most one linked customer.
Dates need to be in the format 2013-01-21T23:08:00Z
User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

branchId: branchId

customer_number: 5987953

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: 2024-01-13T11:01:33.476Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

nameSuffix: nameSuffix

relationship_status: single

title: Dr.

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

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

JSON response body fields:

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

customer_number: 5987953

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: 2024-01-13T11:01:33.476Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

relationship_status: single

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

Typical Successful Response:

								
									{
  "customer_id":"String",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"felixsmith@example.com",
  "face_image":{
    "url":"www.openbankproject",
    "date":"1100-01-01T00:00:00Z"
  },
  "date_of_birth":"1100-01-01T00:00:00Z",
  "relationship_status":"single",
  "dependants":1,
  "dob_of_dependants":["1100-01-01T00:00:00Z"],
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":false,
  "last_ok_date":"2024-01-13T11:01:34Z"
}

Request Headers:

Response Headers:

Required Roles:

CanCreateCustomer - Please login to request this Role
CanCreateUserCustomerLink - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-30006: Customer Number already exists. Please specify a different value for BANK_ID or CUSTOMER_NUMBER.
OBP-20006: User is missing one or more roles:
OBP-20005: User not found. Please specify a valid value for USER_ID.
OBP-30024: Could not create Consumer
OBP-30007: The User is already linked to a Customer at the bank specified by BANK_ID
OBP-30025: Could not create user_customer_links
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv2.0.0, function_name: by createCustomer, operation_id: OBPv2.0.0-createCustomer Tags: Customer, Person, Old-Style,

Create Customer Social Media Handle

Create a customer social media handle for the customer specified by CUSTOMER_ID

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

URL Parameters:

BANK_ID: gh.29.uk

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

JSON request body fields:

customer_number: 5987953

JSON response body fields:

success:

Typical Successful Response:

								
									{
  "success":"Success"
}

Request Headers:

Response Headers:

Required Roles:

CanAddSocialMediaHandle - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-10001: Incorrect json format.
OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
OBP-20006: User is missing one or more roles:
OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv2.0.0, function_name: by addSocialMediaHandle, operation_id: OBPv2.0.0-addSocialMediaHandle Tags: Customer,

Create User Customer Link

Link a User to a Customer

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

CanCreateUserCustomerLink OR CanCreateUserCustomerLinkAtAnyBank entitlements are required.

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

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

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

JSON response body fields:

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

date_inserted:

is_active: false

user_customer_link_id:

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

Typical Successful Response:

								
									{
  "user_customer_link_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "date_inserted":"1100-01-01T00:00:00Z",
  "is_active":true
}

Request Headers:

Response Headers:

Required Roles:

CanCreateUserCustomerLink - Please login to request this Role
CanCreateUserCustomerLinkAtAnyBank - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-10001: Incorrect json format.
OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
OBP-20006: User is missing one or more roles:
OBP-30007: The User is already linked to a Customer at the bank specified by BANK_ID
OBP-30025: Could not create user_customer_links
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv2.0.0, function_name: by createUserCustomerLinks, operation_id: OBPv2.0.0-createUserCustomerLinks Tags: Customer, User, Old-Style,

Get CRM Events

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:

actual_date: 2020-01-27

bank_id: gh.29.uk

customer_number: 5987953

detail:

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

result:

scheduled_date: 2020-01-27

Typical Successful Response:

								
									{
  "crm_events":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "bank_id":"gh.29.uk",
    "customer_name":"String",
    "customer_number":"5987953",
    "category":"String",
    "detail":"String",
    "channel":"String",
    "scheduled_date":"1100-01-01T00:00:00Z",
    "actual_date":"1100-01-01T00:00:00Z",
    "result":"String"
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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

Connector Methods:

Version: OBPv1.4.0, function_name: by getCrmEvents, operation_id: OBPv1.4.0-getCrmEvents Tags: Customer,

Get Customer Social Media Handles

Get social media handles for a customer specified by CUSTOMER_ID.

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

URL Parameters:

BANK_ID: gh.29.uk

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

JSON response body fields:

checks:

customer_number: 5987953

Typical Successful Response:

								
									{
  "checks":[{
    "customer_number":"5987953",
    "type":"PlaceholderString",
    "handle":"PlaceholderString",
    "date_added":"1100-01-01T00:00:00Z",
    "date_activated":"1100-01-01T00:00:00Z"
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanGetSocialMediaHandles - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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

Connector Methods:

Version: OBPv2.0.0, function_name: by getSocialMediaHandles, operation_id: OBPv2.0.0-getSocialMediaHandles Tags: Customer,

Get customer for logged in user

Information about the currently authenticated user.

Authentication via OAuth is required.

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:

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

customer_number: 5987953

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: 2024-01-13T11:01:33.476Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

relationship_status: single

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

Typical Successful Response:

								
									{
  "customer_id":"String",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"felixsmith@example.com",
  "face_image":{
    "url":"www.openbankproject",
    "date":"1100-01-01T00:00:00Z"
  },
  "date_of_birth":"1100-01-01T00:00:00Z",
  "relationship_status":"single",
  "dependants":1,
  "dob_of_dependants":["1100-01-01T00:00:00Z"],
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":false,
  "last_ok_date":"2024-01-13T11:01:34Z"
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

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

Connector Methods:

Version: OBPv1.4.0, function_name: by getCustomer, operation_id: OBPv1.4.0-getCustomer Tags: Customer, Old-Style,

Get documentation about the selected endpoints as:

Resource Docs JSON
Swagger 2 JSON
中文版本
Partial Functions

Note: You can list just the APIs that are implemented in a certain version by appending &native=true to the index URL.
API_Explorer Commit

Featured APIs

API Explorer

v2.0.0 (112 APIs)

Create Customer

Create Customer Social Media Handle

Create User Customer Link

Get CRM Events

Get Customer Social Media Handles

Get customer for logged in user