right logo image
right logo image
Log on

API Explorer

Log off

v3.1.0 (249 APIs)

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

Answer Auth Context Update Challenge

Answer Auth Context Update Challenge.

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

  • key: CustomerNumber

  • 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"
}
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:
Implemented in OBPv3.1.0 by answerUserAuthContextUpdateChallenge, operation_id: OBPv3.1.0-answerUserAuthContextUpdateChallenge

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

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:

JSON response body fields:

  • key: CustomerNumber

  • 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"
}
Required Roles:
  • CanCreateUserAuthContext - Please login to request this Role
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:
Implemented in OBPv3.1.0 by createUserAuthContext, operation_id: OBPv3.1.0-createUserAuthContext

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:

JSON request body fields:

JSON response body fields:

  • key: CustomerNumber

  • 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"
}
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.
Connector Methods:
Implemented in OBPv3.1.0 by createUserAuthContextUpdateRequest, operation_id: OBPv3.1.0-createUserAuthContextUpdateRequest

Delete User Auth Context

Delete a User AuthContext of the User specified by USER_AUTH_CONTEXT_ID.

Authentication is Mandatory

URL Parameters:

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

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Required Roles:
  • CanDeleteUserAuthContext - 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 OBPv3.1.0 by deleteUserAuthContextById, operation_id: OBPv3.1.0-deleteUserAuthContextById

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:

								
									
{
  "jsonString":"{}"
}
Required Roles:
  • CanDeleteUserAuthContext - 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 OBPv3.1.0 by deleteUserAuthContexts, operation_id: OBPv3.1.0-deleteUserAuthContexts

Get User (Current)

Get the logged in user

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 OBPv3.0.0 by getCurrentUser, operation_id: OBPv3.0.0-getCurrentUser

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:

  • key: CustomerNumber

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

  • value: 5987953

Typical Successful Response:

								
									
{
  "user_auth_contexts":[{
    "user_auth_context_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "key":"CUSTOMER_NUMBER",
    "value":"78987432"
  }]
}
Required Roles:
  • CanGetUserAuthContext - 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-30053: Could not insert the UserAuthContext
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getUserAuthContexts, operation_id: OBPv3.1.0-getUserAuthContexts

Get User Lock Status

Get User Login Status.
Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "username":"felixsmith",
  "bad_attempts_since_last_success_or_reset":0,
  "last_failure_date":"2017-09-19T00:00:00Z"
}
Required Roles:
  • CanReadUserLockedStatus - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20027: User not found by username.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getBadLoginStatus, operation_id: OBPv3.1.0-getBadLoginStatus

Get User by USERNAME

Get user by USERNAME

Authentication is Mandatory

CanGetAnyUser entitlement is required,

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-20027: User not found by username.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.0.0 by getUserByUsername, operation_id: OBPv3.0.0-getUserByUsername

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:

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-20005: User not found. Please specify a valid value for USER_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.0.0 by getUserByUserId, operation_id: OBPv3.0.0-getUserByUserId

Get Users by Email Address

Get users by email address

Authentication is Mandatory
CanGetAnyUser entitlement is required,

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 OBPv3.0.0 by getUser, operation_id: OBPv3.0.0-getUser

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

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

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

  • locked_status (if null ignore)

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 OBPv3.0.0 by getUsers, operation_id: OBPv3.0.0-getUsers

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:

Typical Successful Response:

								
									
{
  "duration_time":"10 ms"
}
Required Roles:
  • CanRefreshUser - Please login to request this Role
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:
Implemented in OBPv3.1.0 by refreshUser, operation_id: OBPv3.1.0-refreshUser

Unlock the user

Unlock a User.

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

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "username":"felixsmith",
  "bad_attempts_since_last_success_or_reset":0,
  "last_failure_date":"2017-09-19T00:00:00Z"
}
Required Roles:
  • CanUnlockUser - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20027: User not found by username.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by unlockUser, operation_id: OBPv3.1.0-unlockUser