right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (624 APIs)

API Host: https://apisandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

Check Custom View Names

Check custom view names.

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

JSON response body fields:

success:

debug_info: debug_info

Typical Successful Response: 

								
									
{
  "success":true
}
Required Roles:
  • CanGetSystemIntegrity - 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-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by customViewNamesCheck, operation_id: OBPv5.1.0-customViewNamesCheck Tags: System-Integrity,

Check System View Names

Check system view names.

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

JSON response body fields:

success:

debug_info: debug_info

Typical Successful Response: 

								
									
{
  "success":true
}
Required Roles:
  • CanGetSystemIntegrity - 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-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by systemViewNamesCheck, operation_id: OBPv5.1.0-systemViewNamesCheck Tags: System-Integrity,

Check Unique Index at Account Access

Check unique index at account access table.

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

JSON response body fields:

success:

debug_info: debug_info

Typical Successful Response: 

								
									
{
  "success":true
}
Required Roles:
  • CanGetSystemIntegrity - 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-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by accountAccessUniqueIndexCheck, operation_id: OBPv5.1.0-accountAccessUniqueIndexCheck Tags: System-Integrity,

Check for Orphaned Accounts

Check for orphaned accounts at Bank Account model

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

success:

debug_info: debug_info

Typical Successful Response: 

								
									
{
  "success":true
}
Required Roles:
  • CanGetSystemIntegrity - 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-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by orphanedAccountCheck, operation_id: OBPv5.1.0-orphanedAccountCheck Tags: System-Integrity,

Check for Sensible Currencies

Check for sensible currencies at Bank Account model

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

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

success:

debug_info: debug_info

Typical Successful Response: 

								
									
{
  "success":true
}
Required Roles:
  • CanGetSystemIntegrity - 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-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by accountCurrencyCheck, operation_id: OBPv5.1.0-accountCurrencyCheck Tags: System-Integrity,