v5.1.0 filtered by tag: User-Invitation (4 APIs)
API Host: https://apisandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions
Create User Invitation
Typical Successful Response:
{
"first_name":"ACCOUNT_MANAGEMENT_FEE",
"last_name":"ACCOUNT_MANAGEMENT_FEE",
"email":"felixsmith@example.com",
"company":"TESOBE",
"country":"Germany",
"purpose":"Developer",
"status":"CREATED"
}
Required Roles:
-
CanCreateUserInvitation
- Please login to request this Role
Validations:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Possible Errors:
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30008: User Customer Link not found by USER_ID
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0,
function_name: by createUserInvitation, operation_id: OBPv4.0.0-createUserInvitation
Tags: User-Invitation, KYC, New-Style,
Get User Invitation
Get User Invitation
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
SECRET_LINK: SECRET_LINK
JSON response body fields:
company: company
country: country
purpose: purpose
Typical Successful Response:
{
"first_name":"ACCOUNT_MANAGEMENT_FEE",
"last_name":"ACCOUNT_MANAGEMENT_FEE",
"email":"felixsmith@example.com",
"company":"TESOBE",
"country":"Germany",
"purpose":"Developer",
"status":"CREATED"
}
Required Roles:
-
CanGetUserInvitation
- Please login to request this Role
Validations:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Possible Errors:
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0,
function_name: by getUserInvitation, operation_id: OBPv4.0.0-getUserInvitation
Tags: User-Invitation, New-Style,
Get User Invitation Information
Create User Invitation Information.
Authentication is Optional
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
secret_key: secret_key
JSON response body fields:
company: company
country: country
purpose: purpose
Typical Successful Response:
{
"first_name":"ACCOUNT_MANAGEMENT_FEE",
"last_name":"ACCOUNT_MANAGEMENT_FEE",
"email":"felixsmith@example.com",
"company":"TESOBE",
"country":"Germany",
"purpose":"Developer",
"status":"CREATED"
}
Validations:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Possible Errors:
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30008: User Customer Link not found by USER_ID
- OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0,
function_name: by getUserInvitationAnonymous, operation_id: OBPv4.0.0-getUserInvitationAnonymous
Tags: User-Invitation, KYC, New-Style,
Get User Invitations
Typical Successful Response:
{
"first_name":"ACCOUNT_MANAGEMENT_FEE",
"last_name":"ACCOUNT_MANAGEMENT_FEE",
"email":"felixsmith@example.com",
"company":"TESOBE",
"country":"Germany",
"purpose":"Developer",
"status":"CREATED"
}
Required Roles:
-
CanGetUserInvitation
- Please login to request this Role
Validations:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
Possible Errors:
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0,
function_name: by getUserInvitations, operation_id: OBPv4.0.0-getUserInvitations
Tags: User-Invitation, New-Style,