Initiate an account access consent request

post

https://api.sandbox.tapico.io/v1/account-access-consents

Initiate a request to gain consent from your user, to share their account data with your Application.

Returns a URL where the user can securely authorise your data sharing request with their Account Servicer.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

applicationId

uuid

Unique identifier for Application.

accountServicerId

uuid

Identifies the account servicer where data is to be shared from.

Optional - If omitted then a list of account servicers will be displayed for the user to select from. If provided then this step will be skipped.

externalUserId

string

required

System identifier that represents the user in your Application. This will be used later to reference the data which is consented to be shared by this user.

consentTypes

array of objects

The list of data points being requested from the user. Optional - If omitted then will default to the full set configured against your Application.

consentTypes

callbackUri

uri

Where the user will be sent back to once the consent journey is complete. Should typically be a location on your Application. Optional - If omitted then will default to the value configured against your Application.

transactionFromDateTime

date-time

The earliest point from which transaction data can be retrieved against this consent. This applies to all attempts to retrieve data against this consent.

If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.

transactionToDateTime

date-time

The latest point from which transaction data can be retrieved against this consent. This applies to all attempts to retrieve data against this consent.

If this is not populated, the end date will be open ended, and data will be returned until the latest available transaction.

userIpAddress

string

The user's IP address if the user is currently logged in with the calling Application.

daysBeforeExpirationNotification

integer

Number of days before consent expiration when your application will receive a notification to remind about the need to reconfirm the consent. This field is only used by Open Banking consents. Optional - If omitted then a default value of 10 days will be used to send a notification before expiration.

Headers

region

string

enum

Specifies the Region for the request. When specified, this must match the region that the application access token was generated for.

For more information about regions see https://docs.tapico.io/docs/regions

Allowed:

Responses

201success response.

400Bad Request.

401The credentials used are not recognised.

403Forbidden.

409This request is already in progress please try again later.

422Request parameter validation error.

429Too many requests sent in quick succession.

500Internal Server Error.