right logo image
right logo image
Log on

API Explorer

Log off

v2.2.0 (143 APIs)

API Host: https://api.ttk.com.mk
Bank
Accounts
Views
Counterparties
Transactions

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:

JSON response body fields:

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"
    }]
  }
}
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 be longer than 16 characters.
  • Error occurred during user creation.
  • User with the same username already exists.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv2.0.0 by createUser, operation_id: OBPv2.0.0-createUser

Get User (Current)

Get the logged in user

Login is required.

Authentication is Mandatory

JSON response body fields:

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"
    }]
  }
}
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv2.0.0 by getCurrentUser, operation_id: OBPv2.0.0-getCurrentUser

Get Users by Email Address

Get users by email address

Login is required.
CanGetAnyUser entitlement is required,

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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"
      }]
    }
  }]
}
Required Roles:
  • CanGetAnyUser - Please login to request this Role
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:
Implemented in OBPv2.0.0 by getUser, operation_id: OBPv2.0.0-getUser

Get all Users

Get all users

Login is required.
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

  • sort_direction=ASC/DESC ==> default value: DESC.

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

  • locked_status (if null ignore)

Authentication is Mandatory

JSON response body fields:

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"
      }]
    }
  }]
}
Required Roles:
  • CanGetAnyUser - Please login to request this Role
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:
Implemented in OBPv2.1.0 by getUsers, operation_id: OBPv2.1.0-getUsers