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 View
- Get access for specific user
- Get account by id
- Get accounts at all banks (Private, inc views)
- Get accounts at bank (Private)
- Get private accounts at all banks (Authenticated access)
- Get private accounts at one bank
- Get public accounts at all banks (Anonymous access)
- Update Account Label
- Update View
Account Public
- Get public accounts at one bank (Anonymous access)
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
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...
- Add a customer
- Get CRM Events
- Get customer for logged in user
Customer Message
Documentation
Dynamic Resource Doc
- A test endpoint
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 (Full)
Transaction Metadata
Transaction Request
- Get Transaction Request Types for Account
View Custom

v1.4.0 (86 APIs)

Anfitrión de la API: https://obp-api-sandbox.nmbbank.co.tz

Add a customer

Add a customer linked to the currently authenticated user.
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.
Note: This call is depreciated in favour of v.2.0.0 createCustomer

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-05-21T15:10:45.839Z

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-05-21T15:10:45.839Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

relationship_status: single

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

Respuesta Exitosa Típica:

								
									{
  "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-05-21T15:10:46Z"
}

Request Headers:

Response Headers:

Roles Requeridos:

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

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-20001: User not logged in. Authentication is required!
OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-10001: Incorrect json format.
entitlements required
OBP-30006: Customer Number already exists. Please specify a different value for BANK_ID or CUSTOMER_NUMBER.
Problem getting user_id
OBP-20005: User not found. Please specify a valid value for USER_ID.
Could not create customer
Could not create user_customer_links
OBP-50000: Unknown Error.
OBP-20006: User is missing one or more roles:

Métodos de conector::

Version: OBPv1.4.0, function_name: by addCustomer, operation_id: OBPv1.4.0-addCustomer Tags: Customer, 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

Respuesta Exitosa Típica:

								
									{
  "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:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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.

Métodos de conector::

Version: OBPv1.4.0, function_name: by getCrmEvents, operation_id: OBPv1.4.0-getCrmEvents 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-05-21T15:10:45.839Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

relationship_status: single

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

Respuesta Exitosa Típica:

								
									{
  "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-05-21T15:10:46Z"
}

Request Headers:

Response Headers:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

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

Métodos de conector::

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

v1.4.0 (86 APIs)

Add a customer

Get CRM Events

Get customer for logged in user