{"swagger":"2.0","info":{"title":"Open Bank Project API","description":"An Open Source API for Banks. (c) TESOBE GmbH. 2011 - 2024. Licensed under the AGPL and commercial licences.","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v4.0.0"},"host":"apisandbox.openbankproject.com","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Direct-Login","in":"header","name":"Authorization"},"gatewayLogin":{"type":"apiKey","description":"https://github.com/OpenBankProject/OBP-API/wiki/Gateway-Login","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/account-access":{"put":{"tags":["Account-Access","View-Custom","Account","User","OwnerViewRequired"],"summary":"Revoke/Grant User access to View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"
Revoke/Grant the logged in User access to the views identified by json.
Authentication is Mandatory and the user needs to be an account holder or has owner view access.
","operationId":"revokeGrantUserAccessToViews","parameters":[{"in":"body","name":"body","description":"PostRevokeGrantAccountAccessJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostRevokeGrantAccountAccessJsonV400"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/RevokedJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/account-access/grant":{"post":{"tags":["Account-Access","View-Custom","Account","User","OwnerViewRequired"],"summary":"Grant User access to View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Grants the User identified by USER_ID access to the view identified by VIEW_ID.
Authentication is Mandatory and the user needs to be account holder.
","operationId":"grantUserAccessToView","parameters":[{"in":"body","name":"body","description":"PostAccountAccessJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostAccountAccessJsonV400"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/ViewJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/account-access/revoke":{"post":{"tags":["Account-Access","View-Custom","Account","User","OwnerViewRequired"],"summary":"Revoke User access to View","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Revoke the User identified by USER_ID access to the view identified by VIEW_ID.
Authentication is Mandatory and the user needs to be account holder.
","operationId":"revokeUserAccessToView","parameters":[{"in":"body","name":"body","description":"PostAccountAccessJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostAccountAccessJsonV400"}},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/RevokedJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/permissions":{"get":{"tags":["View-Custom","Account","User","Entitlement"],"summary":"Get access","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Returns the list of the permissions at BANK_ID for account ACCOUNT_ID, with each time a pair composed of the user and the views that he has access to.
Authentication is Mandatory
and the user needs to have access to the owner view.
Returns the list of the views at BANK_ID for account ACCOUNT_ID that a user identified by PROVIDER_ID at their provider PROVIDER has access to.
All url parameters must be %-encoded, which is often especially relevant for USER_ID and PROVIDER.
Authentication is Mandatory
The user needs to have access to the owner view.
","operationId":"getPermissionForUserForBankAccount","parameters":[{"in":"path","name":"PROVIDER","description":"the user PROVIDER","required":true,"type":"string"},{"in":"path","name":"PROVIDER_ID","description":"The provider id","required":true,"type":"string"},{"in":"path","name":"ACCOUNT_ID","description":"The account id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ViewsJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/accounts/{ACCOUNT_ID}/user-account-access":{"post":{"tags":["Account-Access","View-Custom","Account","User","OwnerViewRequired","DAuth"],"summary":"Create (DAuth) User with Account Access","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"This endpoint is used as part of the DAuth solution to grant access to account and transaction data to a smart contract on the blockchain.
Put the smart contract address in username
For provider use "dauth"
This endpoint will create the (DAuth) User with username and provider if the User does not already exist.
Authentication is Mandatory and the logged in user needs to be account holder.
For information about DAuth see below:
DAuth is an experimental authentication mechanism that aims to pin an ethereum or other blockchain Smart Contract to an OBP "User".
In the future, it might be possible to be more specific and pin specific actors (wallets) that are acting within the smart contract, but so far, one smart contract acts on behalf of one User.
Thus, if a smart contract "X" calls the OBP API using the DAuth header, OBP will get or create a user called X and the call will proceed in the context of that User "X".
DAuth is invoked by the REST client (caller) including a specific header (see step 3 below) in any OBP REST call.
When OBP receives the DAuth token, it creates or gets a User with a username based on the smart_contract_address and the provider based on the network_name. The combination of username and provider is unique in OBP.
If you are calling OBP-API via an API3 Airnode, the Airnode will take care of constructing the required header.
When OBP detects a DAuth header / token it first checks if the Consumer is allowed to make such a call. OBP will validate the Consumer ip address and signature etc.
Note: The DAuth flow does not require an explicit POST like Direct Login to create the token.
Permissions may be assigned to an OBP User at any time, via the UserAuthContext, Views, Entitlements to Roles or Consents.
Note: DAuth is NOT enabled on this instance!
Note: The DAuth client is responsible for creating a token which will be trusted by OBP absolutely!
To use DAuth:
Set up properties in your props file
# -- DAuth --------------------------------------# Define secret used to validate JWT token# jwt.public_key_rsa=path-to-the-pem-file# Enable/Disable DAuth communication at all# In case isn't defined default value is false# allow_dauth=false# Define comma separated list of allowed IP addresses# dauth.host=127.0.0.1# -------------------------------------- DAuth--
Please keep in mind that property jwt.public_key_rsa is used to validate JWT token to check it is not changed or corrupted during transport.
The following videos are available:
* DAuth in local environment
HEADER:ALGORITHM & TOKEN TYPE
{ "alg": "RS256", "typ": "JWT"}
PAYLOAD:DATA
{ "smart_contract_address": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224", "network_name": "AIRNODE.TESTNET.ETHEREUM", "msg_sender": "0xe12340927f1725E7734CE288F8367e1Bb143E90fhku767", "consumer_key": "0x1234a4ec31e89cea54d1f125db7536e874ab4a96b4d4f6438668b6bb10a6adb", "timestamp": "2021-11-04T14:13:40Z", "request_id": "0Xe876987694328763492876348928736497869273649"}
VERIFY SIGNATURE
RSASHA256( base64UrlEncode(header) + "." + base64UrlEncode(payload),) your-RSA-key-pair
Here is an example token:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k
Using your favorite http client:
GET https://apisandbox.openbankproject.com/obp/v3.0.0/users/current
Body
Leave Empty!
Headers:
DAuth: your-jwt-from-step-above
Here is it all together:
GET https://apisandbox.openbankproject.com/obp/v3.0.0/users/current HTTP/1.1
Host: localhost:8080
User-Agent: curl/7.47.0
Accept: /
DAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k
CURL example
curl -v -H 'DAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k' https://apisandbox.openbankproject.com/obp/v3.0.0/users/current
You should receive a response like:
{ "user_id": "4c4d3175-1e5c-4cfd-9b08-dcdc209d8221", "email": "", "provider_id": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224", "provider": "ETHEREUM", "username": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224", "entitlements": { "list": [] }}
The file, dauth.scala handles the DAuth,
We:
-> Check if Props allow_dauth is true -> Check if DAuth header exists -> Check if getRemoteIpAddress is OK -> Look for "token" -> parse the JWT token and getOrCreate the user -> get the data of the user
Parameter names and values are case sensitive.
Each parameter MUST NOT appear more than once per request.
Authentication is Mandatory
","operationId":"getEntitlementsForBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/EntitlementsJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/user_customer_links":{"post":{"tags":["Customer","User"],"summary":"Create User Customer Link","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Link a User to a Customer
Authentication is Mandatory
","operationId":"createUserCustomerLinks","parameters":[{"in":"body","name":"body","description":"CreateUserCustomerLinkJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateUserCustomerLinkJson"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/UserCustomerLinkJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/users/{USER_ID}/entitlements":{"get":{"tags":["Role","Entitlement","User"],"summary":"Get Entitlements for User at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Entitlements specified by BANK_ID and USER_ID
Authentication is Mandatory
","operationId":"getEntitlementsByBankAndUser","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"USER_ID","description":"The user id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/EntitlementJSONs"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/users/current/auth-context-updates/{AUTH_CONTEXT_UPDATE_ID}/challenge":{"post":{"tags":["User"],"summary":"Answer Auth Context Update Challenge","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Answer Auth Context Update Challenge.
Authentication is Mandatory
","operationId":"answerUserAuthContextUpdateChallenge","parameters":[{"in":"body","name":"body","description":"PostUserAuthContextUpdateJsonV310 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostUserAuthContextUpdateJsonV310"}},{"in":"path","name":"AUTH_CONTEXT_UPDATE_ID","description":"the auth context update id","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/UserAuthContextUpdateJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/banks/{BANK_ID}/users/current/auth-context-updates/{SCA_METHOD}":{"post":{"tags":["User"],"summary":"Create User Auth Context Update Request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"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.
Get Customers at Any Bank.
Authentication is Mandatory
","operationId":"getCustomersAtAnyBank","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomerJSONsV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/customers-minimal":{"get":{"tags":["Customer","User"],"summary":"Get Customers Minimal at Any Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Customers Minimal at Any Bank.
Authentication is Mandatory
","operationId":"getCustomersMinimalAtAnyBank","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomersMinimalJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/entitlement-requests":{"get":{"tags":["Role","Entitlement","User"],"summary":"Get all Entitlement Requests","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get all Entitlement Requests
Authentication is Mandatory
","operationId":"getAllEntitlementRequests","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/EntitlementRequestsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Role","Entitlement","User"],"summary":"Create Entitlement Request for current User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create Entitlement Request.
Any logged in User can use this endpoint to request an Entitlement
Entitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)
For a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
For a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
Authentication is Mandatory
","operationId":"addEntitlementRequest","parameters":[{"in":"body","name":"body","description":"CreateEntitlementJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateEntitlementJSON"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/EntitlementRequestJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/entitlement-requests/{ENTITLEMENT_REQUEST_ID}":{"delete":{"tags":["Role","Entitlement","User"],"summary":"Delete Entitlement Request","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete the Entitlement Request specified by ENTITLEMENT_REQUEST_ID for a user specified by USER_ID
Authentication is Mandatory
","operationId":"deleteEntitlementRequest","parameters":[{"in":"path","name":"ENTITLEMENT_REQUEST_ID","description":"the entitlement request id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/management/user/reset-password-url":{"post":{"tags":["User"],"summary":"Create password reset url","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create password reset url.
Authentication is Mandatory
","operationId":"resetPasswordUrl","parameters":[{"in":"body","name":"body","description":"PostResetPasswordUrlJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostResetPasswordUrlJsonV400"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/ResetPasswordUrlJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/my/entitlement-requests":{"get":{"tags":["Role","Entitlement","User"],"summary":"Get Entitlement Requests for the current User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Entitlement Requests for the current User.
Authentication is Mandatory
","operationId":"getEntitlementRequestsForCurrentUser","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/EntitlementRequestsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/my/entitlements":{"get":{"tags":["Role","Entitlement","User"],"summary":"Get Entitlements for the current User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Entitlements for the current User.
Authentication is Mandatory
","operationId":"getEntitlementsForCurrentUser","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/EntitlementJSONs"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/my/spaces":{"get":{"tags":["User"],"summary":"Get My Spaces","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get My Spaces.
Authentication is Mandatory
","operationId":"getMySpaces","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/MySpaces"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/my/user/attributes":{"get":{"tags":["User"],"summary":"Get My Personal User Attributes","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get My Personal User Attributes.
Authentication is Mandatory
","operationId":"getMyPersonalUserAttributes","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/UserAttributesResponseJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["User"],"summary":"Create My Personal User Attribute","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create My Personal User Attribute
The type
field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
Authentication is Mandatory
","operationId":"createMyPersonalUserAttribute","parameters":[{"in":"body","name":"body","description":"UserAttributeJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/UserAttributeJsonV400"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/UserAttributeResponseJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/my/user/attributes/USER_ATTRIBUTE_ID":{"put":{"tags":["User"],"summary":"Update My Personal User Attribute","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"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
","operationId":"updateMyPersonalUserAttribute","parameters":[{"in":"body","name":"body","description":"UserAttributeJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/UserAttributeJsonV400"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/UserAttributeResponseJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/user-entitlements":{"post":{"tags":["Role","Entitlement","User","DAuth"],"summary":"Create (DAuth) User with Roles","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"This endpoint is used as part of the DAuth solution to grant Entitlements for Roles to a smart contract on the blockchain.
Put the smart contract address in username
For provider use "dauth"
This endpoint will create the User with username and provider if the User does not already exist.
Then it will create Entitlements i.e. grant Roles to the User.
Entitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)
i.e. Entitlements are used to create / consume system or bank level resources where as views / account access are used to consume / create customer level resources.
For a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
For a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
Note: The Roles actually granted will depend on the Roles that the calling user has.
If you try to grant Entitlements to a user that already exist (duplicate entitilements) you will get an error.
For information about DAuth see below:
DAuth is an experimental authentication mechanism that aims to pin an ethereum or other blockchain Smart Contract to an OBP "User".
In the future, it might be possible to be more specific and pin specific actors (wallets) that are acting within the smart contract, but so far, one smart contract acts on behalf of one User.
Thus, if a smart contract "X" calls the OBP API using the DAuth header, OBP will get or create a user called X and the call will proceed in the context of that User "X".
DAuth is invoked by the REST client (caller) including a specific header (see step 3 below) in any OBP REST call.
When OBP receives the DAuth token, it creates or gets a User with a username based on the smart_contract_address and the provider based on the network_name. The combination of username and provider is unique in OBP.
If you are calling OBP-API via an API3 Airnode, the Airnode will take care of constructing the required header.
When OBP detects a DAuth header / token it first checks if the Consumer is allowed to make such a call. OBP will validate the Consumer ip address and signature etc.
Note: The DAuth flow does not require an explicit POST like Direct Login to create the token.
Permissions may be assigned to an OBP User at any time, via the UserAuthContext, Views, Entitlements to Roles or Consents.
Note: DAuth is NOT enabled on this instance!
Note: The DAuth client is responsible for creating a token which will be trusted by OBP absolutely!
To use DAuth:
Set up properties in your props file
# -- DAuth --------------------------------------# Define secret used to validate JWT token# jwt.public_key_rsa=path-to-the-pem-file# Enable/Disable DAuth communication at all# In case isn't defined default value is false# allow_dauth=false# Define comma separated list of allowed IP addresses# dauth.host=127.0.0.1# -------------------------------------- DAuth--
Please keep in mind that property jwt.public_key_rsa is used to validate JWT token to check it is not changed or corrupted during transport.
The following videos are available:
* DAuth in local environment
HEADER:ALGORITHM & TOKEN TYPE
{ "alg": "RS256", "typ": "JWT"}
PAYLOAD:DATA
{ "smart_contract_address": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224", "network_name": "AIRNODE.TESTNET.ETHEREUM", "msg_sender": "0xe12340927f1725E7734CE288F8367e1Bb143E90fhku767", "consumer_key": "0x1234a4ec31e89cea54d1f125db7536e874ab4a96b4d4f6438668b6bb10a6adb", "timestamp": "2021-11-04T14:13:40Z", "request_id": "0Xe876987694328763492876348928736497869273649"}
VERIFY SIGNATURE
RSASHA256( base64UrlEncode(header) + "." + base64UrlEncode(payload),) your-RSA-key-pair
Here is an example token:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k
Using your favorite http client:
GET https://apisandbox.openbankproject.com/obp/v3.0.0/users/current
Body
Leave Empty!
Headers:
DAuth: your-jwt-from-step-above
Here is it all together:
GET https://apisandbox.openbankproject.com/obp/v3.0.0/users/current HTTP/1.1
Host: localhost:8080
User-Agent: curl/7.47.0
Accept: /
DAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k
CURL example
curl -v -H 'DAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k' https://apisandbox.openbankproject.com/obp/v3.0.0/users/current
You should receive a response like:
{ "user_id": "4c4d3175-1e5c-4cfd-9b08-dcdc209d8221", "email": "", "provider_id": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224", "provider": "ETHEREUM", "username": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224", "entitlements": { "list": [] }}
The file, dauth.scala handles the DAuth,
We:
-> Check if Props allow_dauth is true -> Check if DAuth header exists -> Check if getRemoteIpAddress is OK -> Look for "token" -> parse the JWT token and getOrCreate the user -> get the data of the user
Parameter names and values are case sensitive.
Each parameter MUST NOT appear more than once per request.
Authentication is Mandatory
","operationId":"createUserWithRoles","parameters":[{"in":"body","name":"body","description":"PostCreateUserWithRolesJsonV400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/PostCreateUserWithRolesJsonV400"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/EntitlementsJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/users":{"get":{"tags":["User"],"summary":"Get all Users","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get all users
Authentication is Mandatory
CanGetAnyUser entitlement is required,
Possible custom url parameters for pagination:
eg1:?limit=100&offset=0
eg2:?limit=100&offset=0&sort_direction=ASC
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
","operationId":"createUser","parameters":[{"in":"body","name":"body","description":"CreateUserJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateUserJson"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/UserJsonV200"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/users/{USERNAME}/lock-status":{"get":{"tags":["User"],"summary":"Get User Lock Status","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get User Login Status.
Authentication is Mandatory
Unlock a User.
(Perhaps the user was locked due to multiple failed login attempts)
Authentication is Mandatory
","operationId":"unlockUser","parameters":[{"in":"path","name":"USERNAME","description":"the user name","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BadLoginStatusJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/users/{USERNAME}/locks":{"post":{"tags":["User"],"summary":"Lock the user","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Lock a User.
Authentication is Mandatory
","operationId":"lockUser","parameters":[{"in":"path","name":"USERNAME","description":"the user name","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/UserLockStatusJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/users/{USER_ID}":{"delete":{"tags":["User"],"summary":"Delete a User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete a User.
Authentication is Mandatory
","operationId":"deleteUser","parameters":[{"in":"path","name":"USER_ID","description":"The user id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/users/{USER_ID}/attributes":{"get":{"tags":["User"],"summary":"Get User with Attributes by USER_ID","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get User Attributes for the user defined via USER_ID.
Authentication is Mandatory
","operationId":"getUserWithAttributes","parameters":[{"in":"path","name":"USER_ID","description":"The user id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/UserWithAttributesResponseJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/users/{USER_ID}/auth-context":{"delete":{"tags":["User"],"summary":"Delete User's Auth Contexts","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete the Auth Contexts of a User specified by USER_ID.
Authentication is Mandatory
","operationId":"deleteUserAuthContexts","parameters":[{"in":"path","name":"USER_ID","description":"The user id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"get":{"tags":["User"],"summary":"Get User Auth Contexts","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get User Auth Contexts for a User.
Authentication is Mandatory
","operationId":"getUserAuthContexts","parameters":[{"in":"path","name":"USER_ID","description":"The user id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/UserAuthContextsJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["User"],"summary":"Create User Auth Context","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"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
Delete a User AuthContext of the User specified by USER_AUTH_CONTEXT_ID.
Authentication is Mandatory
","operationId":"deleteUserAuthContextById","parameters":[{"in":"path","name":"USER_AUTH_CONTEXT_ID","description":"the user auth context id","required":true,"type":"string"},{"in":"path","name":"USER_ID","description":"The user id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/users/{USER_ID}/entitlement-requests":{"get":{"tags":["Role","Entitlement","User"],"summary":"Get Entitlement Requests for a User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get Entitlement Requests for a User.
Authentication is Mandatory
","operationId":"getEntitlementRequests","parameters":[{"in":"path","name":"USER_ID","description":"The user id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/EntitlementRequestsJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/users/{USER_ID}/entitlement/{ENTITLEMENT_ID}":{"delete":{"tags":["Role","User","Entitlement"],"summary":"Delete Entitlement","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Delete Entitlement specified by ENTITLEMENT_ID for an user specified by USER_ID
Authentication is required and the user needs to be a Super Admin.
Super Admins are listed in the Props file.
Authentication is Mandatory
","operationId":"deleteEntitlement","parameters":[{"in":"body","name":"body","description":"EmptyClassJson object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EmptyClassJson"}},{"in":"path","name":"ENTITLEMENT_ID","description":"The entitblement id","required":true,"type":"string"},{"in":"path","name":"USER_ID","description":"The user id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/EmptyClassJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/users/{USER_ID}/entitlements":{"get":{"tags":["Role","Entitlement","User"],"summary":"Get Entitlements for User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Authentication is Mandatory
","operationId":"getEntitlements","parameters":[{"in":"path","name":"USER_ID","description":"The user id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/EntitlementsJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}},"post":{"tags":["Role","Entitlement","User"],"summary":"Add Entitlement for a User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Create Entitlement. Grant Role to User.
Entitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)
For a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
For a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
Authentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file.
Authentication is Mandatory
","operationId":"addEntitlement","parameters":[{"in":"body","name":"body","description":"CreateEntitlementJSON object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/CreateEntitlementJSON"}},{"in":"path","name":"USER_ID","description":"The user id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/EntitlementJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/users/{USER_ID}/refresh":{"post":{"tags":["User"],"summary":"Refresh User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"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
","operationId":"refreshUser","parameters":[{"in":"path","name":"USER_ID","description":"The user id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/RefreshUserJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserHasMissingRoles"}}}}},"/obp/v4.0.0/users/current":{"get":{"tags":["User"],"summary":"Get User (Current)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the logged in user
Authentication is Mandatory
","operationId":"getCurrentUser","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/UserJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/users/current/customers":{"get":{"tags":["Customer","User"],"summary":"Get Customers for Current User","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Gets all Customers that are linked to a User.
Authentication is Mandatory
","operationId":"getCustomersForUser","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/CustomersWithAttributesJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/users/current/logout-link":{"get":{"tags":["User"],"summary":"Get Logout Link","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the Logout Link
Authentication is Mandatory
","operationId":"getLogoutLink","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/LogoutLinkJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/users/current/user_id":{"get":{"tags":["User"],"summary":"Get User Id (Current)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get the USER_ID of the logged in user
Authentication is Mandatory
","operationId":"getCurrentUserId","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/UserIdJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}},"/obp/v4.0.0/users/email/EMAIL/terminator":{"get":{"tags":["User"],"summary":"Get Users by Email Address","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"Get users by email address
Authentication is Mandatory
CanGetAnyUser entitlement is required,
Get user by USER_ID
Authentication is Mandatory
CanGetAnyUser entitlement is required,
Get user by USERNAME
Authentication is Mandatory
CanGetAnyUser entitlement is required,
","operationId":"getUserByUsername","parameters":[{"in":"path","name":"USERNAME","description":"the user name","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/UserJsonV400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUserNotLoggedIn"}}}}}},"definitions":{"ErrorUserNotLoggedIn":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"ErrorUserHasMissingRoles":{"properties":{"message":{"type":"string","example":"OBP-20006: User is missing one or more roles: "}}},"NotSupportedYet":{"properties":{}},"PostCreateUserWithRolesJsonV400":{"required":["username","provider","roles"],"properties":{"username":{"type":"string","example":"felixsmith"},"provider":{"type":"string","example":"dauth.ETHEREUM"},"roles":{"type":"array","items":{"$ref":"#/definitions/CreateEntitlementJSON"}}}},"PostRevokeGrantAccountAccessJsonV400":{"required":["views"],"properties":{"views":{"type":"array","items":{"type":"string"}}}},"AmountOfMoneyJsonV121":{"required":["currency","amount"],"properties":{"currency":{"type":"string","example":"EUR"},"amount":{"type":"string","example":"0"}}},"CustomerWithAttributesJsonV300":{"required":["customer_id","name_suffix","email","branch_id","mobile_phone_number","customer_number","customer_attributes","highest_education_attained","dob_of_dependants","bank_id","date_of_birth","last_ok_date","employment_status","legal_name","title","face_image","dependants","relationship_status","kyc_status"],"properties":{"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"name_suffix":{"type":"string","example":"Sr"},"email":{"type":"string","example":"felixsmith@example.com"},"branch_id":{"type":"string","example":"DERBY6"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"customer_number":{"type":"string","example":"5987953"},"customer_attributes":{"type":"array","items":{"$ref":"#/definitions/CustomerAttributeResponseJsonV300"}},"highest_education_attained":{"type":"string","example":"Master"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string","example":"gh.29.uk"},"date_of_birth":{"type":"string","example":"19900101"},"credit_rating":{"$ref":"#/definitions/CustomerCreditRatingJSON"},"last_ok_date":{"type":"string","format":"date","example":"2023-03-26T11:02:48Z"},"employment_status":{"type":"string","example":"worker"},"legal_name":{"type":"string","example":"Eveline Tripman"},"credit_limit":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"title":{"type":"string","example":"Dr."},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"1"},"relationship_status":{"type":"string","example":"single"},"kyc_status":{"type":"boolean","example":"true"}}},"LogoutLinkJson":{"required":["link"],"properties":{"link":{"type":"string","example":"127.0.0.1:8080/user_mgt/logout"}}},"CustomerMinimalJsonV400":{"required":["bank_id","customer_id"],"properties":{"bank_id":{"type":"string","example":"gh.29.uk"},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"}}},"EntitlementRequestsJSON":{"required":["entitlement_requests"],"properties":{"entitlement_requests":{"type":"array","items":{"$ref":"#/definitions/EntitlementRequestJSON"}}}},"CreateEntitlementJSON":{"required":["bank_id","role_name"],"properties":{"bank_id":{"type":"string","example":"gh.29.uk"},"role_name":{"type":"string","example":"CanCreateBranch"}}},"UsersJsonV400":{"required":["users"],"properties":{"users":{"type":"array","items":{"$ref":"#/definitions/UserJsonV400"}}}},"CustomerJsonV300":{"required":["customer_id","name_suffix","email","branch_id","mobile_phone_number","customer_number","highest_education_attained","dob_of_dependants","bank_id","date_of_birth","last_ok_date","employment_status","legal_name","title","face_image","dependants","relationship_status","kyc_status"],"properties":{"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"name_suffix":{"type":"string","example":"Sr"},"email":{"type":"string","example":"felixsmith@example.com"},"branch_id":{"type":"string","example":"DERBY6"},"mobile_phone_number":{"type":"string","example":"+44 07972 444 876"},"customer_number":{"type":"string","example":"5987953"},"highest_education_attained":{"type":"string","example":"Master"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string","example":"gh.29.uk"},"date_of_birth":{"type":"string","example":"19900101"},"credit_rating":{"$ref":"#/definitions/CustomerCreditRatingJSON"},"last_ok_date":{"type":"string","format":"date","example":"2023-03-26T11:02:48Z"},"employment_status":{"type":"string","example":"worker"},"legal_name":{"type":"string","example":"Eveline Tripman"},"credit_limit":{"$ref":"#/definitions/AmountOfMoneyJsonV121"},"title":{"type":"string","example":"Dr."},"face_image":{"$ref":"#/definitions/CustomerFaceImageJson"},"dependants":{"type":"integer","format":"int32","example":"1"},"relationship_status":{"type":"string","example":"single"},"kyc_status":{"type":"boolean","example":"true"}}},"UserAuthContextUpdateJson":{"required":["user_auth_context_update_id","user_id","key","status","value"],"properties":{"user_auth_context_update_id":{"type":"string","example":"613c83ea-80f9-4560-8404-b9cd4ec42a7f"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"key":{"type":"string","example":"CUSTOMER_NUMBER"},"status":{"type":"string","example":"INITIATED"},"value":{"type":"string","example":"78987432"}}},"EntitlementJsonV400":{"required":["entitlement_id","role_name","bank_id","user_id"],"properties":{"entitlement_id":{"type":"string","example":""},"role_name":{"type":"string","example":""},"bank_id":{"type":"string","example":"gh.29.uk"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}},"CustomerCreditRatingJSON":{"required":["rating","source"],"properties":{"rating":{"type":"string","example":"OBP"},"source":{"type":"string","example":"OBP"}}},"UserJsonV400":{"required":["provider","email","username","is_deleted","provider_id","user_id","is_locked","entitlements"],"properties":{"provider":{"type":"string","example":"http://127.0.0.1:8080"},"email":{"type":"string","example":"felixsmith@example.com"},"username":{"type":"string","example":"felixsmith"},"is_deleted":{"type":"boolean","example":"false"},"provider_id":{"type":"string","example":"Chris"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"views":{"$ref":"#/definitions/ViewsJSON300"},"is_locked":{"type":"boolean","example":"false"},"entitlements":{"$ref":"#/definitions/EntitlementJSONs"},"last_marketing_agreement_signed_date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"agreements":{"type":"array","items":{"$ref":"#/definitions/UserAgreementJson"}}}},"ViewJSON300":{"required":["bank_id","account_id","view_id"],"properties":{"bank_id":{"type":"string","example":"gh.29.uk"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"view_id":{"type":"string","example":"owner"}}},"UserJsonV300":{"required":["provider","email","username","provider_id","user_id","entitlements"],"properties":{"provider":{"type":"string","example":"http://127.0.0.1:8080"},"email":{"type":"string","example":"felixsmith@example.com"},"username":{"type":"string","example":"felixsmith"},"provider_id":{"type":"string","example":"Chris"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"views":{"$ref":"#/definitions/ViewsJSON300"},"entitlements":{"$ref":"#/definitions/EntitlementJSONs"}}},"UserCustomerLinkJson":{"required":["is_active","customer_id","user_id","date_inserted","user_customer_link_id"],"properties":{"is_active":{"type":"boolean","example":"true"},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"date_inserted":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"user_customer_link_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}},"CustomersMinimalJsonV400":{"required":["customers"],"properties":{"customers":{"type":"array","items":{"$ref":"#/definitions/CustomerMinimalJsonV400"}}}},"UserLockStatusJson":{"required":["user_id","type_of_lock","last_lock_date"],"properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"type_of_lock":{"type":"string","example":"lock_via_api"},"last_lock_date":{"type":"string","format":"date","example":"1100-01-01T01:01:01Z"}}},"RevokedJsonV400":{"required":["revoked"],"properties":{"revoked":{"type":"boolean","example":"true"}}},"PostUserAuthContextUpdateJsonV310":{"required":["answer"],"properties":{"answer":{"type":"string","example":"123"}}},"PostCreateUserAccountAccessJsonV400":{"required":["username","provider","views"],"properties":{"username":{"type":"string","example":"felixsmith"},"provider":{"type":"string","example":"dauth.ETHEREUM"},"views":{"type":"array","items":{"$ref":"#/definitions/PostViewJsonV400"}}}},"CustomersWithAttributesJsonV300":{"required":["customers"],"properties":{"customers":{"type":"array","items":{"$ref":"#/definitions/CustomerWithAttributesJsonV300"}}}},"RefreshUserJson":{"required":["duration_time"],"properties":{"duration_time":{"type":"string","example":"10 ms"}}},"CreateUserJson":{"required":["first_name","email","username","last_name","password"],"properties":{"first_name":{"type":"string","example":"Simon"},"email":{"type":"string","example":"felixsmith@example.com"},"username":{"type":"string","example":"felixsmith"},"last_name":{"type":"string","example":"Redfern"},"password":{"type":"string","example":"String"}}},"UserJsonV200":{"required":["provider","email","username","provider_id","user_id","entitlements"],"properties":{"provider":{"type":"string","example":"http://127.0.0.1:8080"},"email":{"type":"string","example":"felixsmith@example.com"},"username":{"type":"string","example":"felixsmith"},"provider_id":{"type":"string","example":"Chris"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"entitlements":{"$ref":"#/definitions/EntitlementJSONs"}}},"UserAttributesResponseJson":{"required":["user_attributes"],"properties":{"user_attributes":{"type":"array","items":{"$ref":"#/definitions/UserAttributeResponseJsonV400"}}}},"CustomerJSONsV300":{"required":["customers"],"properties":{"customers":{"type":"array","items":{"$ref":"#/definitions/CustomerJsonV300"}}}},"CustomerFaceImageJson":{"required":["url","date"],"properties":{"url":{"type":"string","example":"www.openbankproject"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"MySpaces":{"required":["bank_ids"],"properties":{"bank_ids":{"type":"array","items":{"type":"string"}}}},"PostAccountAccessJsonV400":{"required":["user_id","view"],"properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"view":{"$ref":"#/definitions/PostViewJsonV400"}}},"ViewsJSON300":{"required":["list"],"properties":{"list":{"type":"array","items":{"$ref":"#/definitions/ViewJSON300"}}}},"PermissionJSON":{"required":["user","views"],"properties":{"user":{"$ref":"#/definitions/UserJSONV121"},"views":{"type":"array","items":{"$ref":"#/definitions/ViewJSONV121"}}}},"ViewJSONV121":{"required":["can_see_transaction_start_date","can_add_url","can_add_where_tag","can_see_transaction_this_bank_account","can_see_bank_account_owners","can_see_private_alias","can_edit_owner_comment","can_see_other_account_national_identifier","can_see_public_alias","can_see_physical_location","can_see_owner_comment","can_see_bank_account_iban","can_see_corporate_location","can_see_bank_account_number","can_see_other_account_bank_name","description","can_see_transaction_other_bank_account","can_delete_corporate_location","can_see_comments","can_see_bank_account_bank_name","can_add_more_info","can_see_other_account_number","can_see_other_account_swift_bic","can_add_open_corporates_url","can_see_other_account_kind","can_delete_physical_location","can_see_bank_account_label","can_see_transaction_currency","is_public","can_see_transaction_finish_date","can_add_tag","can_see_images","can_see_bank_account_currency","hide_metadata_if_alias_used","can_delete_where_tag","alias","can_add_image_url","can_add_comment","can_see_image_url","id","can_see_bank_account_national_identifier","can_see_tags","can_see_open_corporates_url","short_name","can_delete_tag","can_see_more_info","can_see_transaction_metadata","can_delete_comment","can_see_where_tag","can_add_private_alias","can_add_public_alias","can_see_bank_account_swift_bic","can_add_image","can_see_transaction_type","can_see_other_account_iban","can_add_physical_location","can_add_corporate_location","can_delete_image","can_see_url","can_see_bank_account_balance","can_see_transaction_balance","can_see_transaction_amount","can_see_other_account_metadata","can_see_bank_account_type","can_see_transaction_description"],"properties":{"can_see_transaction_start_date":{"type":"boolean","example":"true"},"can_add_url":{"type":"boolean","example":"true"},"can_add_where_tag":{"type":"boolean","example":"true"},"can_see_transaction_this_bank_account":{"type":"boolean","example":"true"},"can_see_bank_account_owners":{"type":"boolean","example":"true"},"can_see_private_alias":{"type":"boolean","example":"true"},"can_edit_owner_comment":{"type":"boolean","example":"true"},"can_see_other_account_national_identifier":{"type":"boolean","example":"true"},"can_see_public_alias":{"type":"boolean","example":"true"},"can_see_physical_location":{"type":"boolean","example":"true"},"can_see_owner_comment":{"type":"boolean","example":"true"},"can_see_bank_account_iban":{"type":"boolean","example":"true"},"can_see_corporate_location":{"type":"boolean","example":"true"},"can_see_bank_account_number":{"type":"boolean","example":"true"},"can_see_other_account_bank_name":{"type":"boolean","example":"true"},"description":{"type":"string","example":"description"},"can_see_transaction_other_bank_account":{"type":"boolean","example":"true"},"can_delete_corporate_location":{"type":"boolean","example":"true"},"can_see_comments":{"type":"boolean","example":"true"},"can_see_bank_account_bank_name":{"type":"boolean","example":"true"},"can_add_more_info":{"type":"boolean","example":"true"},"can_see_other_account_number":{"type":"boolean","example":"true"},"can_see_other_account_swift_bic":{"type":"boolean","example":"true"},"can_add_open_corporates_url":{"type":"boolean","example":"true"},"can_see_other_account_kind":{"type":"boolean","example":"true"},"can_delete_physical_location":{"type":"boolean","example":"true"},"can_see_bank_account_label":{"type":"boolean","example":"true"},"can_see_transaction_currency":{"type":"boolean","example":"true"},"is_public":{"type":"boolean","example":"true"},"can_see_transaction_finish_date":{"type":"boolean","example":"true"},"can_add_tag":{"type":"boolean","example":"true"},"can_see_images":{"type":"boolean","example":"true"},"can_see_bank_account_currency":{"type":"boolean","example":"true"},"hide_metadata_if_alias_used":{"type":"boolean","example":"true"},"can_delete_where_tag":{"type":"boolean","example":"true"},"alias":{"type":"string","example":"None"},"can_add_image_url":{"type":"boolean","example":"true"},"can_add_comment":{"type":"boolean","example":"true"},"can_see_image_url":{"type":"boolean","example":"true"},"id":{"type":"string","example":"123"},"can_see_bank_account_national_identifier":{"type":"boolean","example":"true"},"can_see_tags":{"type":"boolean","example":"true"},"can_see_open_corporates_url":{"type":"boolean","example":"true"},"short_name":{"type":"string","example":"short_name"},"can_delete_tag":{"type":"boolean","example":"true"},"can_see_more_info":{"type":"boolean","example":"true"},"can_see_transaction_metadata":{"type":"boolean","example":"true"},"can_delete_comment":{"type":"boolean","example":"true"},"can_see_where_tag":{"type":"boolean","example":"true"},"can_add_private_alias":{"type":"boolean","example":"true"},"can_add_public_alias":{"type":"boolean","example":"true"},"can_see_bank_account_swift_bic":{"type":"boolean","example":"true"},"can_add_image":{"type":"boolean","example":"true"},"can_see_transaction_type":{"type":"boolean","example":"true"},"can_see_other_account_iban":{"type":"boolean","example":"true"},"can_add_physical_location":{"type":"boolean","example":"true"},"can_add_corporate_location":{"type":"boolean","example":"true"},"can_delete_image":{"type":"boolean","example":"true"},"can_see_url":{"type":"boolean","example":"true"},"can_see_bank_account_balance":{"type":"boolean","example":"true"},"can_see_transaction_balance":{"type":"boolean","example":"true"},"can_see_transaction_amount":{"type":"boolean","example":"true"},"can_see_other_account_metadata":{"type":"boolean","example":"true"},"can_see_bank_account_type":{"type":"boolean","example":"true"},"can_see_transaction_description":{"type":"boolean","example":"true"}}},"UserAttributeJsonV400":{"required":["name","type","value"],"properties":{"name":{"type":"string","example":"BATTERY_LEVEL"},"type":{"type":"string","example":"STRING"},"value":{"type":"string","example":"90"}}},"ViewsJsonV300":{"required":["views"],"properties":{"views":{"type":"array","items":{"$ref":"#/definitions/ViewJsonV300"}}}},"EntitlementsJsonV400":{"required":["list"],"properties":{"list":{"type":"array","items":{"$ref":"#/definitions/EntitlementJsonV400"}}}},"ViewJsonV300":{"required":["can_see_transaction_start_date","can_add_url","can_add_where_tag","can_see_transaction_this_bank_account","can_see_bank_account_owners","can_see_bank_routing_address","can_see_private_alias","can_edit_owner_comment","is_system","can_see_other_account_national_identifier","can_see_bank_routing_scheme","can_see_public_alias","can_see_physical_location","can_see_owner_comment","can_see_bank_account_iban","can_see_corporate_location","can_see_bank_account_number","can_see_other_account_bank_name","description","can_see_bank_account_routing_scheme","can_see_transaction_other_bank_account","can_delete_corporate_location","can_see_comments","can_see_bank_account_bank_name","can_add_more_info","can_create_direct_debit","can_see_other_account_number","can_see_other_account_swift_bic","can_add_open_corporates_url","can_see_other_account_kind","can_add_transaction_request_to_own_account","can_delete_physical_location","can_see_bank_account_label","can_see_transaction_currency","is_public","can_see_transaction_finish_date","can_see_bank_account_routing_address","can_add_tag","can_see_images","can_query_available_funds","can_see_bank_account_credit_limit","can_see_bank_account_currency","hide_metadata_if_alias_used","can_delete_where_tag","alias","can_add_image_url","can_add_comment","can_see_image_url","id","can_create_standing_order","can_see_bank_account_national_identifier","can_add_counterparty","can_add_transaction_request_to_any_account","can_see_tags","can_see_open_corporates_url","short_name","can_delete_tag","can_see_other_account_routing_scheme","can_see_more_info","can_see_transaction_metadata","can_delete_comment","can_see_where_tag","can_add_private_alias","can_add_public_alias","can_see_bank_account_swift_bic","can_add_image","can_see_transaction_type","can_see_other_account_routing_address","can_see_other_account_iban","can_add_physical_location","can_add_corporate_location","can_delete_image","can_see_url","can_see_bank_account_balance","can_see_other_bank_routing_address","can_see_transaction_balance","metadata_view","can_see_transaction_amount","can_see_other_account_metadata","can_see_bank_account_type","can_see_other_bank_routing_scheme","can_see_transaction_description"],"properties":{"can_see_transaction_start_date":{"type":"boolean","example":"true"},"can_add_url":{"type":"boolean","example":"true"},"can_add_where_tag":{"type":"boolean","example":"true"},"can_see_transaction_this_bank_account":{"type":"boolean","example":"true"},"can_see_bank_account_owners":{"type":"boolean","example":"true"},"can_see_bank_routing_address":{"type":"boolean","example":"true"},"can_see_private_alias":{"type":"boolean","example":"true"},"can_edit_owner_comment":{"type":"boolean","example":"true"},"is_system":{"type":"boolean","example":"true"},"can_see_other_account_national_identifier":{"type":"boolean","example":"true"},"can_see_bank_routing_scheme":{"type":"boolean","example":"true"},"can_see_public_alias":{"type":"boolean","example":"true"},"can_see_physical_location":{"type":"boolean","example":"true"},"can_see_owner_comment":{"type":"boolean","example":"true"},"can_see_bank_account_iban":{"type":"boolean","example":"true"},"can_see_corporate_location":{"type":"boolean","example":"true"},"can_see_bank_account_number":{"type":"boolean","example":"true"},"can_see_other_account_bank_name":{"type":"boolean","example":"true"},"description":{"type":"string","example":"description"},"can_see_bank_account_routing_scheme":{"type":"boolean","example":"true"},"can_see_transaction_other_bank_account":{"type":"boolean","example":"true"},"can_delete_corporate_location":{"type":"boolean","example":"true"},"can_see_comments":{"type":"boolean","example":"true"},"can_see_bank_account_bank_name":{"type":"boolean","example":"true"},"can_add_more_info":{"type":"boolean","example":"true"},"can_create_direct_debit":{"type":"boolean","example":"true"},"can_see_other_account_number":{"type":"boolean","example":"true"},"can_see_other_account_swift_bic":{"type":"boolean","example":"true"},"can_add_open_corporates_url":{"type":"boolean","example":"true"},"can_see_other_account_kind":{"type":"boolean","example":"true"},"can_add_transaction_request_to_own_account":{"type":"boolean","example":"true"},"can_delete_physical_location":{"type":"boolean","example":"true"},"can_see_bank_account_label":{"type":"boolean","example":"true"},"can_see_transaction_currency":{"type":"boolean","example":"true"},"is_public":{"type":"boolean","example":"true"},"can_see_transaction_finish_date":{"type":"boolean","example":"true"},"can_see_bank_account_routing_address":{"type":"boolean","example":"true"},"can_add_tag":{"type":"boolean","example":"true"},"can_see_images":{"type":"boolean","example":"true"},"can_query_available_funds":{"type":"boolean","example":"true"},"can_see_bank_account_credit_limit":{"type":"boolean","example":"true"},"can_see_bank_account_currency":{"type":"boolean","example":"true"},"hide_metadata_if_alias_used":{"type":"boolean","example":"true"},"can_delete_where_tag":{"type":"boolean","example":"true"},"alias":{"type":"string","example":"No"},"can_add_image_url":{"type":"boolean","example":"true"},"can_add_comment":{"type":"boolean","example":"true"},"can_see_image_url":{"type":"boolean","example":"true"},"id":{"type":"string","example":"1234"},"can_create_standing_order":{"type":"boolean","example":"true"},"can_see_bank_account_national_identifier":{"type":"boolean","example":"true"},"can_add_counterparty":{"type":"boolean","example":"true"},"can_add_transaction_request_to_any_account":{"type":"boolean","example":"true"},"can_see_tags":{"type":"boolean","example":"true"},"can_see_open_corporates_url":{"type":"boolean","example":"true"},"short_name":{"type":"string","example":"short_name"},"can_delete_tag":{"type":"boolean","example":"true"},"can_see_other_account_routing_scheme":{"type":"boolean","example":"true"},"can_see_more_info":{"type":"boolean","example":"true"},"can_see_transaction_metadata":{"type":"boolean","example":"true"},"can_delete_comment":{"type":"boolean","example":"true"},"can_see_where_tag":{"type":"boolean","example":"true"},"can_add_private_alias":{"type":"boolean","example":"true"},"is_firehose":{"type":"boolean"},"can_add_public_alias":{"type":"boolean","example":"true"},"can_see_bank_account_swift_bic":{"type":"boolean","example":"true"},"can_add_image":{"type":"boolean","example":"true"},"can_see_transaction_type":{"type":"boolean","example":"true"},"can_see_other_account_routing_address":{"type":"boolean","example":"true"},"can_see_other_account_iban":{"type":"boolean","example":"true"},"can_add_physical_location":{"type":"boolean","example":"true"},"can_add_corporate_location":{"type":"boolean","example":"true"},"can_delete_image":{"type":"boolean","example":"true"},"can_see_url":{"type":"boolean","example":"true"},"can_see_bank_account_balance":{"type":"boolean","example":"true"},"can_see_other_bank_routing_address":{"type":"boolean","example":"true"},"can_see_transaction_balance":{"type":"boolean","example":"true"},"metadata_view":{"type":"string","example":"owner"},"can_see_transaction_amount":{"type":"boolean","example":"true"},"can_see_other_account_metadata":{"type":"boolean","example":"true"},"can_see_bank_account_type":{"type":"boolean","example":"true"},"can_see_other_bank_routing_scheme":{"type":"boolean","example":"true"},"can_see_transaction_description":{"type":"boolean","example":"true"}}},"UserAttributeResponseJsonV400":{"required":["name","insert_date","user_attribute_id","type","value"],"properties":{"name":{"type":"string","example":"BATTERY_LEVEL"},"insert_date":{"type":"string","format":"date","example":"2024-03-26T11:02:48Z"},"user_attribute_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"type":{"type":"string","example":"STRING"},"value":{"type":"string","example":"90"}}},"UserAuthContextJson":{"required":["time_stamp","user_id","key","user_auth_context_id","value"],"properties":{"time_stamp":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"key":{"type":"string","example":"CUSTOMER_NUMBER"},"user_auth_context_id":{"type":"string","example":"613c83ea-80f9-4560-8404-b9cd4ec42a7f"},"value":{"type":"string","example":"78987432"}}},"UserWithAttributesResponseJson":{"required":["provider","email","username","provider_id","user_id","user_attributes"],"properties":{"provider":{"type":"string","example":"http://127.0.0.1:8080"},"email":{"type":"string","example":"felixsmith@example.com"},"username":{"type":"string","example":"felixsmith"},"provider_id":{"type":"string","example":"Chris"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"user_attributes":{"type":"array","items":{"$ref":"#/definitions/UserAttributeResponseJsonV400"}}}},"BadLoginStatusJson":{"required":["username","bad_attempts_since_last_success_or_reset","last_failure_date"],"properties":{"username":{"type":"string","example":"felixsmith"},"bad_attempts_since_last_success_or_reset":{"type":"integer","format":"int32","example":"0"},"last_failure_date":{"type":"string","format":"date","example":"1100-01-01T01:01:01Z"}}},"EntitlementJSONs":{"required":["list"],"properties":{"list":{"type":"array","items":{"$ref":"#/definitions/EntitlementJSON"}}}},"UserJSONV121":{"required":["id","provider","display_name"],"properties":{"id":{"type":"string","example":"5995d6a2-01b3-423c-a173-5481df49bdaf"},"provider":{"type":"string","example":"http://127.0.0.1:8080"},"display_name":{"type":"string","example":"OBP"}}},"UserAgreementJson":{"required":["type","text"],"properties":{"type":{"type":"string","example":""},"text":{"type":"string","example":""}}},"PostUserAuthContextJson":{"required":["key","value"],"properties":{"key":{"type":"string","example":"CUSTOMER_NUMBER"},"value":{"type":"string","example":"78987432"}}},"UserIdJsonV400":{"required":["user_id"],"properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}},"CreateUserCustomerLinkJson":{"required":["user_id","customer_id"],"properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"customer_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"}}},"EntitlementRequestJSON":{"required":["entitlement_request_id","role_name","bank_id","user","created"],"properties":{"entitlement_request_id":{"type":"string","example":"6fb17583-1e49-4435-bb74-a14fe0996723"},"role_name":{"type":"string","example":"CanQueryOtherUser"},"bank_id":{"type":"string","example":"gh.29.uk"},"user":{"$ref":"#/definitions/UserJsonV200"},"created":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"UserAuthContextsJson":{"required":["user_auth_contexts"],"properties":{"user_auth_contexts":{"type":"array","items":{"$ref":"#/definitions/UserAuthContextJson"}}}},"PermissionsJSON":{"required":["permissions"],"properties":{"permissions":{"type":"array","items":{"$ref":"#/definitions/PermissionJSON"}}}},"EntitlementJSON":{"required":["entitlement_id","role_name","bank_id"],"properties":{"entitlement_id":{"type":"string","example":"6fb17583-1e49-4435-bb74-a14fe0996723"},"role_name":{"type":"string","example":"CanQueryOtherUser"},"bank_id":{"type":"string","example":"gh.29.uk"}}},"CustomerAttributeResponseJsonV300":{"required":["customer_attribute_id","name","type","value"],"properties":{"customer_attribute_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"name":{"type":"string","example":"SPECIAL_TAX_NUMBER"},"type":{"type":"string","example":"STRING"},"value":{"type":"string","example":"123456789"}}},"PostViewJsonV400":{"required":["view_id","is_system"],"properties":{"view_id":{"type":"string","example":"owner"},"is_system":{"type":"boolean","example":"true"}}},"EmptyClassJson":{"required":["jsonString"],"properties":{"jsonString":{"type":"string","example":"{}"}}},"PostResetPasswordUrlJsonV400":{"required":["username","email","user_id"],"properties":{"username":{"type":"string","example":"jobloggs"},"email":{"type":"string","example":"jo@gmail.com"},"user_id":{"type":"string","example":"74a8ebcc-10e4-4036-bef3-9835922246bf"}}},"ResetPasswordUrlJsonV400":{"required":["reset_password_url"],"properties":{"reset_password_url":{"type":"string","example":"https://apisandbox.openbankproject.com/user_mgt/reset_password/QOL1CPNJPCZ4BRMPX3Z01DPOX1HMGU3L"}}}}}