right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (538 APIs)

API Host: https://obp-api-sandbox.nmbbank.co.tz
Bank
Accounts
Views
Counterparties
Transactions

Answer User Auth Context Update Challenge

Answer User Auth Context Update Challenge.

Authentication is Mandatory

URL Parameters:

AUTH_CONTEXT_UPDATE_ID:

BANK_ID: gh.29.uk

JSON request body fields:

answer:

JSON response body fields:

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

key: CustomerNumber

status:

user_auth_context_update_id:

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

value: 5987953

Typical Successful Response: 

								
									
{
  "user_auth_context_update_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "key":"CUSTOMER_NUMBER",
  "value":"78987432",
  "status":"INITIATED",
  "consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
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.
  • OBP-10001: Incorrect json format.
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.0.0, function_name: by answerUserAuthContextUpdateChallenge, operation_id: OBPv5.0.0-answerUserAuthContextUpdateChallenge Tags: User,

Create My Personal User Attribute

Create My Personal User Attribute

The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"

Authentication is Mandatory

JSON request body fields:

name: ACCOUNT_MANAGEMENT_FEE

type:

value: 5987953

JSON response body fields:

insert_date: 2020-01-27

name: ACCOUNT_MANAGEMENT_FEE

type:

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

value: 5987953

Typical Successful Response: 

								
									
{
  "user_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "name":"BATTERY_LEVEL",
  "type":"STRING",
  "value":"90",
  "insert_date":"2024-12-02T21:00:26Z"
}
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-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createMyPersonalUserAttribute, operation_id: OBPv4.0.0-createMyPersonalUserAttribute Tags: User,

Create Non Personal User Attribute

Create Non Personal User Attribute

The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"

Authentication is Mandatory

URL Parameters:

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

JSON request body fields:

name: ACCOUNT_MANAGEMENT_FEE

type:

value: 5987953

JSON response body fields:

insert_date: 2020-01-27

is_personal: is_personal

name: ACCOUNT_MANAGEMENT_FEE

type:

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

value: 5987953

Typical Successful Response: 

								
									
{
  "user_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "name":"BATTERY_LEVEL",
  "type":"STRING",
  "value":"90",
  "is_personal":false,
  "insert_date":"2024-12-02T21:00:26Z"
}
Required Roles:
  • CanCreateNonPersonalUserAttribute - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by createNonPersonalUserAttribute, operation_id: OBPv5.1.0-createNonPersonalUserAttribute Tags: User,

Create User

Creates OBP user.
No authorisation (currently) required.

Mimics current webform to Register.

Requires username(email) and password.

Returns 409 error if username not unique.

May require validation of email address.

Authentication is Mandatory

JSON request body fields:

email: felixsmith@example.com

first_name: Tom

last_name: Smith

password: password

username: felixsmith

JSON response body fields:

bank_id: gh.29.uk

email: felixsmith@example.com

entitlement_id:

entitlements:

list:

provider: ETHEREUM

provider_id:

role_name:

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

username: felixsmith

Typical Successful Response: 

								
									
{
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "email":"felixsmith@example.com",
  "provider_id":"Chris",
  "provider":"http://127.0.0.1:8080",
  "username":"felixsmith",
  "entitlements":{
    "list":[{
      "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
      "role_name":"CanQueryOtherUser",
      "bank_id":"gh.29.uk"
    }]
  }
}
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-30207: Invalid Password Format. Your password should EITHER be at least 10 characters long and contain mixed numbers and both upper and lower case letters and at least one special character, OR the length should be > 16 and <= 512.
  • Error occurred during user creation.
  • User with the same username already exists.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by createUser, operation_id: OBPv2.0.0-createUser Tags: User, Onboarding,

Create User Auth Context

Create User Auth Context. These key value pairs will be propagated over connector to adapter. Normally used for mapping OBP user and
Bank User/Customer.
Authentication is Mandatory

URL Parameters:

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

JSON request body fields:

key: CustomerNumber

value: 5987953

JSON response body fields:

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

key: CustomerNumber

time_stamp: 1100-01-01T01:01:01.000Z

user_auth_context_id:

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

value: 5987953

Typical Successful Response: 

								
									
{
  "user_auth_context_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "key":"CUSTOMER_NUMBER",
  "value":"78987432",
  "time_stamp":"1100-01-01T00:00:00Z",
  "consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
Required Roles:
  • CanCreateUserAuthContext - 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-30053: Could not insert the UserAuthContext
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv5.0.0, function_name: by createUserAuthContext, operation_id: OBPv5.0.0-createUserAuthContext Tags: User,

Create User Auth Context Update Request

Create User Auth Context Update Request.
Authentication is Mandatory

A One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD
SCA_METHOD is typically "SMS" or "EMAIL". "EMAIL" is used for testing purposes.

URL Parameters:

BANK_ID: gh.29.uk

SCA_METHOD:

JSON request body fields:

key: CustomerNumber

value: 5987953

JSON response body fields:

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

key: CustomerNumber

status:

user_auth_context_update_id:

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

value: 5987953

Typical Successful Response: 

								
									
{
  "user_auth_context_update_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "key":"CUSTOMER_NUMBER",
  "value":"78987432",
  "status":"INITIATED",
  "consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
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.
  • OBP-10001: Incorrect json format.
  • OBP-30053: Could not insert the UserAuthContext
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.0.0, function_name: by createUserAuthContextUpdateRequest, operation_id: OBPv5.0.0-createUserAuthContextUpdateRequest Tags: User,

Create password reset url

Create password reset url.

Authentication is Mandatory

JSON request body fields:

email: felixsmith@example.com

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

username: felixsmith

JSON response body fields:

reset_password_url:

Typical Successful Response: 

								
									
{
  "reset_password_url":"https://apisandbox.openbankproject.com/user_mgt/reset_password/QOL1CPNJPCZ4BRMPX3Z01DPOX1HMGU3L"
}
Required Roles:
  • CanCreateResetPasswordUrl - 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-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by resetPasswordUrl, operation_id: OBPv4.0.0-resetPasswordUrl Tags: User,

Delete Non Personal User Attribute

Delete the Non Personal User Attribute specified by ENTITLEMENT_REQUEST_ID for a user specified by USER_ID

Authentication is Mandatory

URL Parameters:

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

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

JSON response body fields:

Typical Successful Response:
Required Roles:
  • CanDeleteNonPersonalUserAttribute - 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-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by deleteNonPersonalUserAttribute, operation_id: OBPv5.1.0-deleteNonPersonalUserAttribute Tags: User,

Delete User Auth Context

Delete a User AuthContext of the User specified by USER_AUTH_CONTEXT_ID.

Authentication is Mandatory

URL Parameters:

USER_AUTH_CONTEXT_ID:

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

JSON response body fields:

Typical Successful Response:
Required Roles:
  • CanDeleteUserAuthContext - 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-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by deleteUserAuthContextById, operation_id: OBPv3.1.0-deleteUserAuthContextById Tags: User,

Delete User's Auth Contexts

Delete the Auth Contexts of a User specified by USER_ID.

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

Typical Successful Response:
Required Roles:
  • CanDeleteUserAuthContext - 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-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by deleteUserAuthContexts, operation_id: OBPv3.1.0-deleteUserAuthContexts Tags: User,

Delete a User

Delete a User.

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

Typical Successful Response:
Required Roles:
  • CanDeleteUser - 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-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteUser, operation_id: OBPv4.0.0-deleteUser Tags: User,

Get Logout Link

Get the Logout Link

Authentication is Mandatory

JSON response body fields:

link:

Typical Successful Response: 

								
									
{
  "link":"127.0.0.1:8080/user_mgt/logout"
}
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: OBPv4.0.0, function_name: by getLogoutLink, operation_id: OBPv4.0.0-getLogoutLink Tags: User,

Get My Personal User Attributes

Get My Personal User Attributes.

Authentication is Mandatory

JSON response body fields:

insert_date: 2020-01-27

name: ACCOUNT_MANAGEMENT_FEE

type:

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

user_attributes: user_attributes

value: 5987953

Typical Successful Response: 

								
									
{
  "user_attributes":[{
    "user_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "name":"BATTERY_LEVEL",
    "type":"STRING",
    "value":"90",
    "insert_date":"2024-12-02T21:00:26Z"
  }]
}
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: OBPv4.0.0, function_name: by getMyPersonalUserAttributes, operation_id: OBPv4.0.0-getMyPersonalUserAttributes Tags: User,

Get My Spaces

Get My Spaces.

Authentication is Mandatory

JSON response body fields:

bank_ids: bank_ids

Typical Successful Response: 

								
									
{
  "bank_ids":["gh.29.uk"]
}
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: OBPv4.0.0, function_name: by getMySpaces, operation_id: OBPv4.0.0-getMySpaces Tags: User,

Get Non Personal User Attributes

Get Non Personal User Attribute for a user specified by USER_ID

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

Typical Successful Response:
Required Roles:
  • CanGetNonPersonalUserAttributes - 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-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by getNonPersonalUserAttributes, operation_id: OBPv5.1.0-getNonPersonalUserAttributes Tags: User,

Get User (Current)

Get the logged in user

Authentication is Mandatory

JSON response body fields:

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

bank_id: gh.29.uk

email: felixsmith@example.com

entitlement_id:

entitlements:

list:

provider: ETHEREUM

provider_id:

role_name:

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

username: felixsmith

view_id: owner

views:

Typical Successful Response: 

								
									
{
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "email":"felixsmith@example.com",
  "provider_id":"Chris",
  "provider":"http://127.0.0.1:8080",
  "username":"felixsmith",
  "entitlements":{
    "list":[{
      "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
      "role_name":"CanQueryOtherUser",
      "bank_id":"gh.29.uk"
    }]
  },
  "views":{
    "list":[{
      "bank_id":"gh.29.uk",
      "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
      "view_id":"owner"
    }]
  }
}
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: OBPv3.0.0, function_name: by getCurrentUser, operation_id: OBPv3.0.0-getCurrentUser Tags: User,

Get User Auth Contexts

Get User Auth Contexts for a User.

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

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

key: CustomerNumber

time_stamp: 1100-01-01T01:01:01.000Z

user_auth_context_id:

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

value: 5987953

Typical Successful Response: 

								
									
{
  "user_auth_context_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "key":"CUSTOMER_NUMBER",
  "value":"78987432",
  "time_stamp":"1100-01-01T00:00:00Z",
  "consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
Required Roles:
  • CanGetUserAuthContext - 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-50000: Unknown Error.
Connector Methods:
Version: OBPv5.0.0, function_name: by getUserAuthContexts, operation_id: OBPv5.0.0-getUserAuthContexts Tags: User,

Get User Id (Current)

Get the USER_ID of the logged in user

Authentication is Mandatory

JSON response body fields:

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

Typical Successful Response: 

								
									
{
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
}
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: OBPv4.0.0, function_name: by getCurrentUserId, operation_id: OBPv4.0.0-getCurrentUserId Tags: User,

Get User Lock Status

Get User Login Status.
Authentication is Mandatory

URL Parameters:

PROVIDER: ETHEREUM

USERNAME: felixsmith

JSON response body fields:

bad_attempts_since_last_success_or_reset:

last_failure_date: 2020-01-27

username: felixsmith

Typical Successful Response: 

								
									
{
  "username":"felixsmith",
  "bad_attempts_since_last_success_or_reset":0,
  "last_failure_date":"1100-01-01T01:01:01Z"
}
Required Roles:
  • CanReadUserLockedStatus - 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-20027: User not found by provider and username.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by getUserLockStatus, operation_id: OBPv5.1.0-getUserLockStatus Tags: User,

Get User by USERNAME

Get user by PROVIDER and USERNAME

Authentication is Mandatory

CanGetAnyUser entitlement is required,

URL Parameters:

PROVIDER: ETHEREUM

USERNAME: felixsmith

JSON response body fields:

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

bank_id: gh.29.uk

email: felixsmith@example.com

entitlement_id:

entitlements:

is_deleted: is_deleted

is_locked: is_locked

list:

provider: ETHEREUM

provider_id:

role_name:

text:

type:

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

username: felixsmith

view_id: owner

agreements: agreements

last_marketing_agreement_signed_date: last_marketing_agreement_signed_date

views:

Typical Successful Response: 

								
									
{
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "email":"felixsmith@example.com",
  "provider_id":"Chris",
  "provider":"http://127.0.0.1:8080",
  "username":"felixsmith",
  "entitlements":{
    "list":[{
      "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
      "role_name":"CanQueryOtherUser",
      "bank_id":"gh.29.uk"
    }]
  },
  "views":{
    "list":[{
      "bank_id":"gh.29.uk",
      "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
      "view_id":"owner"
    }]
  },
  "agreements":[{
    "type":"",
    "text":""
  }],
  "is_deleted":false,
  "last_marketing_agreement_signed_date":"1100-01-01T00:00:00Z",
  "is_locked":false
}
Required Roles:
  • CanGetAnyUser - 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-20027: User not found by provider and username.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by getUserByProviderAndUsername, operation_id: OBPv5.1.0-getUserByProviderAndUsername Tags: User,

Get User by USER_ID

Get user by USER_ID

Authentication is Mandatory
CanGetAnyUser entitlement is required,

URL Parameters:

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

JSON response body fields:

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

bank_id: gh.29.uk

email: felixsmith@example.com

entitlement_id:

entitlements:

is_deleted: is_deleted

is_locked: is_locked

list:

provider: ETHEREUM

provider_id:

role_name:

text:

type:

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

username: felixsmith

view_id: owner

agreements: agreements

last_marketing_agreement_signed_date: last_marketing_agreement_signed_date

views:

Typical Successful Response: 

								
									
{
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "email":"felixsmith@example.com",
  "provider_id":"Chris",
  "provider":"http://127.0.0.1:8080",
  "username":"felixsmith",
  "entitlements":{
    "list":[{
      "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
      "role_name":"CanQueryOtherUser",
      "bank_id":"gh.29.uk"
    }]
  },
  "views":{
    "list":[{
      "bank_id":"gh.29.uk",
      "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
      "view_id":"owner"
    }]
  },
  "agreements":[{
    "type":"",
    "text":""
  }],
  "is_deleted":false,
  "last_marketing_agreement_signed_date":"1100-01-01T00:00:00Z",
  "is_locked":false
}
Required Roles:
  • CanGetAnyUser - 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-20005: User not found. Please specify a valid value for USER_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getUserByUserId, operation_id: OBPv4.0.0-getUserByUserId Tags: User,

Get User with Attributes by USER_ID

Get User Attributes for the user defined via USER_ID.

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

email: felixsmith@example.com

insert_date: 2020-01-27

name: ACCOUNT_MANAGEMENT_FEE

provider: ETHEREUM

provider_id:

type:

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

user_attributes: user_attributes

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

username: felixsmith

value: 5987953

Typical Successful Response: 

								
									
{
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "email":"felixsmith@example.com",
  "provider_id":"Chris",
  "provider":"http://127.0.0.1:8080",
  "username":"felixsmith",
  "user_attributes":[{
    "user_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "name":"BATTERY_LEVEL",
    "type":"STRING",
    "value":"90",
    "insert_date":"2024-12-02T21:00:26Z"
  }]
}
Required Roles:
  • CanGetUsersWithAttributes - 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-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by getUserWithAttributes, operation_id: OBPv4.0.0-getUserWithAttributes Tags: User,

Get Users by Email Address

Get users by email address

Authentication is Mandatory
CanGetAnyUser entitlement is required,

URL Parameters:

EMAIL: felixsmith@example.com

JSON response body fields:

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

bank_id: gh.29.uk

email: felixsmith@example.com

entitlement_id:

entitlements:

is_deleted: is_deleted

is_locked: is_locked

list:

provider: ETHEREUM

provider_id:

role_name:

text:

type:

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

username: felixsmith

users: user list

view_id: owner

agreements: agreements

last_marketing_agreement_signed_date: last_marketing_agreement_signed_date

views:

Typical Successful Response: 

								
									
{
  "users":[{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith",
    "entitlements":{
      "list":[{
        "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
        "role_name":"CanQueryOtherUser",
        "bank_id":"gh.29.uk"
      }]
    },
    "views":{
      "list":[{
        "bank_id":"gh.29.uk",
        "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "view_id":"owner"
      }]
    },
    "agreements":[{
      "type":"",
      "text":""
    }],
    "is_deleted":false,
    "last_marketing_agreement_signed_date":"1100-01-01T00:00:00Z",
    "is_locked":false
  }]
}
Required Roles:
  • CanGetAnyUser - 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-20007: User not found by email.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getUsersByEmail, operation_id: OBPv4.0.0-getUsersByEmail Tags: User,

Get all Users

Get all users

Authentication is Mandatory

CanGetAnyUser entitlement is required,

Possible custom url parameters for pagination:

  • limit=NUMBER ==> default value: 50
  • offset=NUMBER ==> default value: 0

eg1:?limit=100&offset=0

  • locked_status (if null ignore)

JSON response body fields:

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

bank_id: gh.29.uk

email: felixsmith@example.com

entitlement_id:

entitlements:

is_deleted: is_deleted

is_locked: is_locked

list:

provider: ETHEREUM

provider_id:

role_name:

text:

type:

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

username: felixsmith

users: user list

view_id: owner

agreements: agreements

last_marketing_agreement_signed_date: last_marketing_agreement_signed_date

views:

Typical Successful Response: 

								
									
{
  "users":[{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith",
    "entitlements":{
      "list":[{
        "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
        "role_name":"CanQueryOtherUser",
        "bank_id":"gh.29.uk"
      }]
    },
    "views":{
      "list":[{
        "bank_id":"gh.29.uk",
        "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
        "view_id":"owner"
      }]
    },
    "agreements":[{
      "type":"",
      "text":""
    }],
    "is_deleted":false,
    "last_marketing_agreement_signed_date":"1100-01-01T00:00:00Z",
    "is_locked":false
  }]
}
Required Roles:
  • CanGetAnyUser - 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-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getUsers, operation_id: OBPv4.0.0-getUsers Tags: User,

Lock the user

Lock a User.

Authentication is Mandatory

URL Parameters:

PROVIDER: ETHEREUM

USERNAME: felixsmith

JSON request body fields:

JSON response body fields:

last_lock_date: 2020-01-27

type_of_lock:

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

Typical Successful Response: 

								
									
{
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "type_of_lock":"lock_via_api",
  "last_lock_date":"1100-01-01T01:01:01Z"
}
Required Roles:
  • CanLockUser - 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-20027: User not found by provider and username.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by lockUserByProviderAndUsername, operation_id: OBPv5.1.0-lockUserByProviderAndUsername Tags: User,

Refresh User

The endpoint is used for updating the accounts, views, account holders for the user.
As to the Json body, you can leave it as Empty.
This call will get data from backend, no need to prepare the json body in api side.

Authentication is Mandatory

URL Parameters:

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

JSON request body fields:

JSON response body fields:

duration_time: 60

Typical Successful Response: 

								
									
{
  "duration_time":"10 ms"
}
Required Roles:
  • CanRefreshUser - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Connector Methods:
Version: OBPv3.1.0, function_name: by refreshUser, operation_id: OBPv3.1.0-refreshUser Tags: User,

Unlock the user

Unlock a User.

(Perhaps the user was locked due to multiple failed login attempts)

Authentication is Mandatory

URL Parameters:

PROVIDER: ETHEREUM

USERNAME: felixsmith

JSON response body fields:

bad_attempts_since_last_success_or_reset:

last_failure_date: 2020-01-27

username: felixsmith

Typical Successful Response: 

								
									
{
  "username":"felixsmith",
  "bad_attempts_since_last_success_or_reset":0,
  "last_failure_date":"1100-01-01T01:01:01Z"
}
Required Roles:
  • CanUnlockUser - 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-20027: User not found by provider and username.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by unlockUserByProviderAndUsername, operation_id: OBPv5.1.0-unlockUserByProviderAndUsername Tags: User,

Update My Personal User Attribute

Update My Personal User Attribute for current user by USER_ATTRIBUTE_ID

The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

insert_date: 2020-01-27

name: ACCOUNT_MANAGEMENT_FEE

type:

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

value: 5987953

Typical Successful Response: 

								
									
{
  "user_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "name":"BATTERY_LEVEL",
  "type":"STRING",
  "value":"90",
  "insert_date":"2024-12-02T21:00:26Z"
}
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-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by updateMyPersonalUserAttribute, operation_id: OBPv4.0.0-updateMyPersonalUserAttribute Tags: User,