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
Required scopes
This endpoint requires the following scopes:
  • : Ability to read Accounts information
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Header parameters
x-fapi-financial-idstringRequired

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-timestringOptional

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

Pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$
x-fapi-customer-ip-addressstringOptional

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

x-fapi-interaction-idstringOptional

An RFC4122 UID used as a correlation id.

AuthorizationstringOptional

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-agentstringOptional

Indicates the user-agent that the PSU is using.

Responses
post
/account-access-consents
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: text
Accept: */*

No content

Get Account Access Consents

get
Required scopes
This endpoint requires the following scopes:
  • : Ability to read Accounts information
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
ConsentIdstringRequired

ConsentId

Header parameters
x-fapi-financial-idstringRequired

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-timestringOptional

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

Pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$
x-fapi-customer-ip-addressstringOptional

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

x-fapi-interaction-idstringOptional

An RFC4122 UID used as a correlation id.

AuthorizationstringOptional

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-agentstringOptional

Indicates the user-agent that the PSU is using.

Responses
get
/account-access-consents/{ConsentId}
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: text
Accept: */*

No content

Delete Account Access Consents

delete
Required scopes
This endpoint requires the following scopes:
  • : Ability to read Accounts information
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
ConsentIdstringRequired

ConsentId

Header parameters
x-fapi-financial-idstringRequired

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-timestringOptional

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

Pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$
x-fapi-customer-ip-addressstringOptional

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

x-fapi-interaction-idstringOptional

An RFC4122 UID used as a correlation id.

AuthorizationstringOptional

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-agentstringOptional

Indicates the user-agent that the PSU is using.

Responses
204

Account Access Consents Deleted

delete
/account-access-consents/{ConsentId}
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: text
Accept: */*

No content

Last updated