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

Request Headers:
                                        

Response Headers:
                                        

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• 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.

• obp.getCustomerByCustomerNumber
• obp.createUserAuthContext
• obp.checkAnswer
• obp.getBankAccountsForUser

								
									
{
  "user_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "name":"BATTERY_LEVEL",
  "type":"STRING",
  "value":"90",
  "insert_date":"2024-11-27T00:00:35Z"
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-10001: Incorrect json format.
• OBP-50000: Unknown Error.

• obp.createOrUpdateUserAttribute

								
									
{
  "user_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "name":"BATTERY_LEVEL",
  "type":"STRING",
  "value":"90",
  "is_personal":false,
  "insert_date":"2024-11-27T00:00:35Z"
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanCreateNonPersonalUserAttribute - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• 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.

• obp.createOrUpdateUserAttribute

								
									
{
  "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"
    }]
  }
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• 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.

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

Request Headers:
                                        

Response Headers:
                                        

• CanCreateUserAuthContext - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• 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:

• obp.createUserAuthContext
• obp.getBankAccountsForUser

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

Request Headers:
                                        

Response Headers:
                                        

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• 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.

• obp.validateUserAuthContextUpdateRequest
• obp.getBankAccountsForUser

								
									
{
  "reset_password_url":"https://apisandbox.openbankproject.com/user_mgt/reset_password/QOL1CPNJPCZ4BRMPX3Z01DPOX1HMGU3L"
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanCreateResetPasswordUrl - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• 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.

Request Headers:
                                        

Response Headers:
                                        

• CanDeleteNonPersonalUserAttribute - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• 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.

• obp.deleteUserAttribute
• obp.getBankAccountsForUser

Request Headers:
                                        

Response Headers:
                                        

• CanDeleteUserAuthContext - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

• obp.deleteUserAuthContextById
• obp.getBankAccountsForUser

Request Headers:
                                        

Response Headers:
                                        

• CanDeleteUserAuthContext - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

• obp.deleteUserAuthContexts
• obp.getBankAccountsForUser

Request Headers:
                                        

Response Headers:
                                        

• CanDeleteUser - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

								
									
{
  "link":"127.0.0.1:8080/user_mgt/logout"
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• Required JSON Validation: No
• Allowed Authentication Types: Not set

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

								
									
{
  "user_attributes":[{
    "user_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "name":"BATTERY_LEVEL",
    "type":"STRING",
    "value":"90",
    "insert_date":"2024-11-27T00:00:35Z"
  }]
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• Required JSON Validation: No
• Allowed Authentication Types: Not set

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

• obp.getPersonalUserAttributes

								
									
{
  "bank_ids":["gh.29.uk"]
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• Required JSON Validation: No
• Allowed Authentication Types: Not set

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

Request Headers:
                                        

Response Headers:
                                        

• CanGetNonPersonalUserAttributes - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• 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.

• obp.getNonPersonalUserAttributes
• obp.getBankAccountsForUser

								
									
{
  "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"
    }]
  }
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• Required JSON Validation: No
• Allowed Authentication Types: Not set

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

• obp.getBankAccountsForUser

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

Request Headers:
                                        

Response Headers:
                                        

• CanGetUserAuthContext - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

• obp.getUserAuthContexts
• obp.getBankAccountsForUser

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

Request Headers:
                                        

Response Headers:
                                        

• Required JSON Validation: No
• Allowed Authentication Types: Not set

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

• obp.getBankAccountsForUser

								
									
{
  "username":"felixsmith",
  "bad_attempts_since_last_success_or_reset":0,
  "last_failure_date":"1100-01-01T01:01:01Z"
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanReadUserLockedStatus - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• 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.

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

Request Headers:
                                        

Response Headers:
                                        

• CanGetAnyUser - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• 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.

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

Request Headers:
                                        

Response Headers:
                                        

• CanGetAnyUser - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• 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.

								
									
{
  "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-11-27T00:00:35Z"
  }]
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanGetUsersWithAttributes - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-50000: Unknown Error.
• OBP-20006: User is missing one or more roles:

• obp.getUserAttributes

								
									
{
  "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
  }]
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanGetAnyUser - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• 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.

								
									
{
  "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
  }]
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanGetAnyUser - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

								
									
{
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "type_of_lock":"lock_via_api",
  "last_lock_date":"1100-01-01T01:01:01Z"
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanLockUser - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• 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.

								
									
{
  "duration_time":"10 ms"
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanRefreshUser - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.
• OBP-20001: User not logged in. Authentication is required!

• obp.getBankAccountsForUser

								
									
{
  "username":"felixsmith",
  "bad_attempts_since_last_success_or_reset":0,
  "last_failure_date":"1100-01-01T01:01:01Z"
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanUnlockUser - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• 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.

								
									
{
  "user_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "name":"BATTERY_LEVEL",
  "type":"STRING",
  "value":"90",
  "insert_date":"2024-11-27T00:00:35Z"
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-10001: Incorrect json format.
• OBP-50000: Unknown Error.

• obp.createOrUpdateUserAttribute
• obp.getPersonalUserAttributes