Connection
The system entity representing the link between a user and a dataholder, this entity will optionally contain what metrics this connection was created for.
The id for this connection
The app this connection belongs to
The id of the user associated with this connection
The dataholder id which this connection pulls data from
The length of time in days the requested consent will last.
365The scopes that have been applied to this connection from the dataholder, will be null if the connection is not in an active, expired or disconnected state
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]
["openid","common:customer.basic:read","common:customer.detail:read","bank:accounts.basic:read","bank:accounts.detail:read","bank:transactions:read"]The metrics associated with this connection, this will be null if it is all metrics
The current state of the connection.
| Enum Value | Description |
|---|---|
| ABANDONED | The connection has not been activated. |
| ACTIVE | The connection is authorised and can be used to access data. |
| CANCELLED | The connection has been cancelled, before a dataholder has been selected. |
| DECLINED | The customer declined the authorisation request, after a dataholder has been selected. |
| DISCONNECTED | The customer has revoked an active connection. |
| EXPIRED | The connection authorisation has expired. |
| INITIATED | The connection has been created but authorisation has not yet been completed. |
| LOGOUT | The authorisation journey ended because the customer logged out. |
Possible values: [INITIATED, ABANDONED, CANCELLED, DECLINED, DISCONNECTED, ACTIVE, EXPIRED, LOGOUT]
connectionState object
The connection state represents a the current status of the connection including timestamps of things that have occurred
The current state of the connection.
| Enum Value | Description |
|---|---|
| ABANDONED | The connection has not been activated. |
| ACTIVE | The connection is authorised and can be used to access data. |
| CANCELLED | The connection has been cancelled, before a dataholder has been selected. |
| DECLINED | The customer declined the authorisation request, after a dataholder has been selected. |
| DISCONNECTED | The customer has revoked an active connection. |
| EXPIRED | The connection authorisation has expired. |
| INITIATED | The connection has been created but authorisation has not yet been completed. |
| LOGOUT | The authorisation journey ended because the customer logged out. |
Possible values: [INITIATED, ABANDONED, CANCELLED, DECLINED, DISCONNECTED, ACTIVE, EXPIRED, LOGOUT]
BANK_ACCOUNT object
Possible values: [SUCCESS, FAILURE]
BANK_BALANCE object
Possible values: [SUCCESS, FAILURE]
BANK_TRANSACTION object
Possible values: [SUCCESS, FAILURE]
USER_INFO object
Possible values: [SUCCESS, FAILURE]
{
"id": "string",
"app": "string",
"user": "string",
"dataholder": "string",
"duration": 365,
"scopes": [
"openid"
],
"connectionState": {
"status": "INITIATED",
"connectedAt": "2024-07-29T15:51:28.071Z",
"disconnectedAt": "2024-07-29T15:51:28.071Z",
"BANK_ACCOUNT": {
"status": "SUCCESS",
"referenceId": "string",
"lastSuccess": "2024-07-29T15:51:28.071Z",
"lastUpdated": "2024-07-29T15:51:28.071Z"
},
"BANK_BALANCE": {
"status": "SUCCESS",
"referenceId": "string",
"lastSuccess": "2024-07-29T15:51:28.071Z",
"lastUpdated": "2024-07-29T15:51:28.071Z"
},
"BANK_TRANSACTION": {
"status": "SUCCESS",
"referenceId": "string",
"lastSuccess": "2024-07-29T15:51:28.071Z",
"lastUpdated": "2024-07-29T15:51:28.071Z"
},
"USER_INFO": {
"status": "SUCCESS",
"referenceId": "string",
"lastSuccess": "2024-07-29T15:51:28.071Z",
"lastUpdated": "2024-07-29T15:51:28.071Z"
}
}
}