Skip to main content

CreateConnection

The details used to initialise a new connection for a user.

userstring<uuid>required

The ID of the user associated with the connection.

dataholderstring<uuid>nullable

The ID of the data holder to connect to. If omitted, the customer can select a data holder during the authorisation journey.

durationintegernullable

The number of days for which consent is requested.

Possible values: >= 1 and <= 365

Default value: 365
scopesScope[]nullable

The permission scopes to request from the customer.

Possible values: [openid, common:customer.basic:read, common:customer.detail:read, bank:accounts.basic:read, bank:accounts.detail:read, bank:transactions:read, bank:regular_payments:read, bank:payees:read]

CreateConnection
{
  "user": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "dataholder": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "duration": 365,
  "scopes": [
    "openid"
  ]
}