API Explorer

v3.1 (144 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create Account Access Consents

Create Account Access Consents

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "Data":{ "ConsentId":"string", "CreationDateTime":"2020-10-20T08:40:47.375Z", "Status":"Authorised", "StatusUpdateDateTime":"2020-10-20T08:40:47.375Z", "Permissions":["ReadAccountsBasic"], "ExpirationDateTime":"2020-10-20T08:40:47.375Z", "TransactionFromDateTime":"2020-10-20T08:40:47.375Z", "TransactionToDateTime":"2020-10-20T08:40:47.375Z" }, "Risk":{ }, "Links":{ "Self":"https://obp-apisandbox.joinfincubator.com/open-banking/v3.1/account-access-consents/CONSENT_ID" }, "Meta":{ "TotalPages":0, "FirstAvailableDateTime":"2020-10-20T08:40:47.375Z", "LastAvailableDateTime":"2020-10-20T08:40:47.375Z" } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: UKv3.1, function_name: by createAccountAccessConsents, operation_id: UKv3.1-createAccountAccessConsents Tags: Account Access,

Delete Account Access Consents

Delete Account Access Consents

Authentication is Mandatory

URL Parameters:

CONSENT_ID:

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: UKv3.1, function_name: by deleteAccountAccessConsentsConsentId, operation_id: UKv3.1-deleteAccountAccessConsentsConsentId Tags: Account Access,

Get Account Access Consents

Get Account Access Consents

Authentication is Mandatory

URL Parameters:

CONSENT_ID:

JSON response body fields:

Typical Successful Response:

								
									
{ "Data":{ "ConsentId":"string", "CreationDateTime":"2020-10-20T10:28:39.801Z", "Status":"Authorised", "StatusUpdateDateTime":"2020-10-20T10:28:39.801Z", "Permissions":["ReadAccountsBasic"], "ExpirationDateTime":"2020-10-20T10:28:39.801Z", "TransactionFromDateTime":"2020-10-20T10:28:39.801Z", "TransactionToDateTime":"2020-10-20T10:28:39.801Z" }, "Risk":"", "Links":{ "Self":"https://obp-apisandbox.joinfincubator.com/open-banking/v3.1/account-access-consents/CONSENT_ID" }, "Meta":{ "TotalPages":0, "FirstAvailableDateTime":"2020-10-20T10:28:39.801Z", "LastAvailableDateTime":"2020-10-20T10:28:39.801Z" } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: UKv3.1, function_name: by getAccountAccessConsentsConsentId, operation_id: UKv3.1-getAccountAccessConsentsConsentId Tags: Account Access,