Account access consents

The API specification for "account-access-consents" provided by Algbra's Open Banking API allows Third Party Providers (TPPs) to request and manage access to their customers' account information.

This API supports the creation, retrieval, and revocation of account access consents for customers of participating financial institutions. TPPs can use this API to request access to account information such as balance and transaction history, with the customer's explicit consent.

The API specification includes details on the endpoints, request and response formats, and authentication methods supported by the API.

Create Account Access Consents

post
Authorizations
body
OBReadConsent1ParamanyRequired

Default

Header parameters
x-fapi-financial-idanyRequired

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-timeanyOptional

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-addressanyOptional

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idanyOptional

An RFC4122 UID used as a correlation id.

AuthorizationanyOptional

An Authorisation Token as per https://tools.ietf.org/html/rfc6750 - required for API calls but may be ommited when using Swagger UI where the "Authorize" function has been operated

x-customer-user-agentanyOptional

Indicates the user-agent that the PSU is using.

Responses
201
Account Access Consents Created
post
POST /algbra/open-banking/v3.1/aisp/account-access-consents HTTP/1.1
Host: secure.tell.systems
Authorization: Bearer YOUR_OAUTH2_TOKEN
x-fapi-financial-id: null
Accept: */*

No content

Get Account Access Consents

get
Authorizations
Path parameters
ConsentIdanyRequired

ConsentId

Header parameters
x-fapi-financial-idanyRequired

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-timeanyOptional

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-addressanyOptional

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idanyOptional

An RFC4122 UID used as a correlation id.

AuthorizationanyOptional

An Authorisation Token as per https://tools.ietf.org/html/rfc6750 - required for API calls but may be ommited when using Swagger UI where the "Authorize" function has been operated

x-customer-user-agentanyOptional

Indicates the user-agent that the PSU is using.

Responses
200
Account Access Consents Read
get
GET /algbra/open-banking/v3.1/aisp/account-access-consents/{ConsentId} HTTP/1.1
Host: secure.tell.systems
Authorization: Bearer YOUR_OAUTH2_TOKEN
x-fapi-financial-id: null
Accept: */*

No content

Delete Account Access Consents

delete
Authorizations
Path parameters
ConsentIdanyRequired

ConsentId

Header parameters
x-fapi-financial-idanyRequired

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-timeanyOptional

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-addressanyOptional

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idanyOptional

An RFC4122 UID used as a correlation id.

AuthorizationanyOptional

An Authorisation Token as per https://tools.ietf.org/html/rfc6750 - required for API calls but may be ommited when using Swagger UI where the "Authorize" function has been operated

x-customer-user-agentanyOptional

Indicates the user-agent that the PSU is using.

Responses
204
Account Access Consents Deleted
delete
DELETE /algbra/open-banking/v3.1/aisp/account-access-consents/{ConsentId} HTTP/1.1
Host: secure.tell.systems
Authorization: Bearer YOUR_OAUTH2_TOKEN
x-fapi-financial-id: null
Accept: */*

No content

Last updated