{"resource_docs":[{"operation_id":"OBPv2.0.0-createUser","implemented_by":{"version":"OBPv2.0.0","function":"createUser"},"request_verb":"POST","request_url":"/obp/v2.0.0/users","summary":"Create User","description":"

Creates OBP user.
\nNo authorisation required.

\n

Mimics current webform to Register.

\n

Requires username(email), password, first_name, last_name, and email.

\n

Validation checks performed:
\n- Password must meet strong password requirements (InvalidStrongPasswordFormat error if not)
\n- Username must be unique (409 error if username already exists)
\n- All required fields must be present in valid JSON format

\n

Email validation behavior:
\n- Controlled by property 'authUser.skipEmailValidation' (default: false)
\n- When false: User is created with validated=false and a validation email is sent to the user's email address
\n- When true: User is created with validated=true and no validation email is sent
\n- Default entitlements are granted immediately regardless of validation status

\n

Note: If email validation is required (skipEmailValidation=false), the user must click the validation link
\nin the email before they can log in, even though entitlements are already granted.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

JSON request body fields:

\n

email: felixsmith@example.com

\n

first_name: Tom

\n

last_name: Smith

\n

password: password

\n

username: felixsmith

\n

JSON response body fields:

\n

bank_id: gh.29.uk

\n

email: felixsmith@example.com

\n

entitlement_id:

\n

entitlements:

\n

list:

\n

provider: ETHEREUM

\n

provider_id:

\n

role_name:

\n

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

\n

username: felixsmith

\n","description_markdown":"Creates OBP user.\n No authorisation required.\n\n Mimics current webform to Register.\n\n Requires username(email), password, first_name, last_name, and email.\n\n Validation checks performed:\n - Password must meet strong password requirements (InvalidStrongPasswordFormat error if not)\n - Username must be unique (409 error if username already exists)\n - All required fields must be present in valid JSON format\n\n Email validation behavior:\n - Controlled by property 'authUser.skipEmailValidation' (default: false)\n - When false: User is created with validated=false and a validation email is sent to the user's email address\n - When true: User is created with validated=true and no validation email is sent\n - Default entitlements are granted immediately regardless of validation status\n\n Note: If email validation is required (skipEmailValidation=false), the user must click the validation link\n in the email before they can log in, even though entitlements are already granted.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**first_name**](/glossary#first_name): Tom\n\n\n\n[**last_name**](/glossary#last_name): Smith\n\n\n\n[**password**](/glossary#): password\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n","example_request_body":{"email":"felixsmith@example.com","username":"felixsmith","password":"String","first_name":"Simon","last_name":"Redfern"},"success_response_body":{"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"}]}},"error_response_bodies":["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.","OBP-20258: Duplicate Username. Cannot create Username because it already exists. ","OBP-20259: Could not check username uniqueness against the external provider. The Connector or Adapter may not be running. ","Error occurred during user creation.","OBP-50000: Unknown Error."],"tags":["User","Onboarding"],"typed_request_body":{"type":"object","properties":{"email":{"type":"string"},"first_name":{"type":"string"},"password":{"type":"string"},"username":{"type":"string"},"last_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users","connector_methods":[]},{"operation_id":"OBPv5.0.0-createAccount","implemented_by":{"version":"OBPv5.0.0","function":"createAccount"},"request_verb":"PUT","request_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID","summary":"Create Account (PUT)","description":"

Create Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID.

\n

The User can create an Account for themself - or - the User that has the USER_ID specified in the POST body.

\n

If the PUT body USER_ID is specified, the logged in user must have the Role canCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.

\n

If the PUT body USER_ID is not specified, the account will be owned by the logged in User.

\n

The 'product_code' field SHOULD be a product_code from Product.
\nIf the 'product_code' matches a product_code from Product, account attributes will be created that match the Product Attributes.

\n

Note: The Amount MUST be zero.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

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

\n

BANK_ID: gh.29.uk

\n

JSON response body fields:

\n

account_attribute_id:

\n

account_attributes:

\n

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

\n

account_routings:

\n

address:

\n

amount: 10.12

\n

balance: 10

\n

branch_id: DERBY6

\n

currency: EUR

\n

label: My Account

\n

name: ACCOUNT_MANAGEMENT_FEE

\n

product_code: 1234BW

\n

scheme: OBP

\n

type:

\n

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

\n

value: 5987953

\n

product_instance_code: product_instance_code

\n","description_markdown":"Create Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID.\n\nThe User can create an Account for themself - or - the User that has the USER_ID specified in the POST body.\n\nIf the PUT body USER_ID *is* specified, the logged in user must have the Role canCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.\n\nIf the PUT body USER_ID is *not* specified, the account will be owned by the logged in User.\n\nThe 'product_code' field SHOULD be a product_code from Product.\nIf the 'product_code' matches a product_code from Product, account attributes will be created that match the Product Attributes.\n\nNote: The Amount MUST be zero.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_attribute_id**](/glossary#account_attribute_id): \n\n\n\n[**account_attributes**](/glossary#account_attributes): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[product_instance_code](/glossary#): product_instance_code\n\n\n","example_request_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","label":"My Account","product_code":"1234BW","balance":{"currency":"EUR","amount":"0"},"branch_id":"DERBY6","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}]},"success_response_body":{"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","label":"My Account","product_code":"1234BW","balance":{"currency":"EUR","amount":"0"},"branch_id":"DERBY6","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"account_attributes":[{"product_code":"1234BW","account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","product_instance_code":"LKJL98769F"}]},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20001: User not logged in. Authentication is required!","OBP-30107: Invalid User Id.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-20005: User not found. Please specify a valid value for USER_ID.","OBP-20006: User is missing one or more roles: ","OBP-30106: Invalid Balance Amount.","OBP-30112: Invalid Number. Initial balance must be a number, e.g 1000.00","OBP-30109: Initial Balance of Account must be Zero (0).","OBP-30105: Invalid Balance Currency.","OBP-30208: Account_ID already exists at the Bank.","OBP-50000: Unknown Error."],"tags":["Account","Onboarding"],"typed_request_body":{"type":"object","properties":{"user_id":{"type":"string"},"product_code":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"label":{"type":"string"},"branch_id":{"type":"string"},"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}}}},"typed_success_response_body":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"product_code":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"branch_id":{"type":"string"},"account_id":{"type":"string"},"user_id":{"type":"string"}}},"roles":[{"role":"CanCreateAccount","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID","connector_methods":[]}]}