API Explorer

Scenario 1: Onboarding a User

		|### 1) Create a user
		|
		|Action:
		|
		|	POST https://obp-api-sandbox.nmbbank.co.tz/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
		|
		|	DirectLogin: token="your-token-from-direct-login"
		|
		|Please note the user_id
		|
		|### 2) Create customer
		|
		|Requires CanCreateCustomer and CanCreateUserCustomerLink roles
		|
		|Action:
		|
		|	POST https://obp-api-sandbox.nmbbank.co.tz/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":"1100-01-01T00:00:00Z"  },  "date_of_birth":"1100-01-01T00:00:00Z",  "relationship_status":"single",  "dependants":10,  "dob_of_dependants":["1100-01-01T00: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":"1100-01-01T00:00:00Z",  "title":"Dr.",  "branch_id":"DERBY6",  "name_suffix":"Sr"}
		|
		|Headers:
		|
		|	Content-Type:  application/json
		|
		|	DirectLogin: token="your-token-from-direct-login"
		|
		|### 3) List customers for the user
		|
		|Action:
		|
		|	GET https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/users/current/customers
		|
		|Body:
		|
		|	Leave empty!
		|
		|Headers:
		|
		|	Content-Type:  application/json
		|
		|	DirectLogin: token="your-token-from-direct-login"
		|
		|### 4) Create user customer link
		|
		|Requires CanCreateCustomer and CanCreateUserCustomerLink roles
		|
		|Action:
		|
		|	POST https://obp-api-sandbox.nmbbank.co.tz/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
		|
		|	DirectLogin: token="your-token-from-direct-login"
		|
		|### 5) Create account
		|
		|Requires CanCreateAccount role
		|
		|Action:
		|
		|	PUT https://obp-api-sandbox.nmbbank.co.tz/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
		|
		|	DirectLogin: token="your-token-from-direct-login"
		|
		|### 6) List accounts
		|
		|Action:
		|
		|	GET https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/my/banks/BANK_ID/accounts/account-id-from-step-5/account
		|
		|Body:
		|
		|	Leave empty!
		|
		|Headers:
		|
		|	Content-Type:  application/json
		|
		|	DirectLogin: token="your-token-from-direct-login"
		|
		|### 7) Create card
		|
		|Requires CanCreateCardsForBank role
		|
		|Action:
		|
		|	POST https://obp-api-sandbox.nmbbank.co.tz/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
		|
		|	DirectLogin: token="your-token-from-direct-login"
		|
		|### 8) List cards
		|
		|Action:
		|
		|	GET https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/cards
		|
		|Body:
		|
		|	Leave empty!
		|
		|Headers:
		|
		|	Content-Type:  application/json
		|
		|	DirectLogin: token="your-token-from-direct-login"
		|