List all connections

This operation will return every connection status for those that had theirpublicTokens already exchanged. You can pass an externalId (more about it in Link parameters) as a parameter to get those connections associated to it.

List connections for the current app

Retrieve every connection status for the connections in the current app

GEThttps://api.finlink.vumi.io/api/v1/queries/connections

Authorization

bearerAuth

Query parameters

Response

200401500

Successfully retrieved all connections

Body

application/json

credentialsTokenstring

Alphanumeric unique identifier of length 10 for the connection.

Example: "AAAAA11111"

statusenum

Status for the current connection.

PENDINGREADYUPDATINGERROREDDELETED

errorDetailsErrorDetailsDto (object)

Error details for a connection

entitystring

ID for the entity that the connection was done for

Example: "santander"

createdAtstring (date-time)

Timestamp in UTC at which the connection was created

updatedAtstring (date-time)

Timestamp in UTC at which the connection was last updated (even if it errored)

lastSyncstring (date-time)

Timestamp in UTC at which the connection was last successfully updated and synced with the entity

updateTokenstring (uuid)

Update token used to launch manual updates to the connection. It is consumed after use

twoFactorEnabledboolean

Indicates if the connection has 2FA

hasCredentialsboolean

Indicates if the connection has the credentials stored for recurrent automatic updates

externalIdstring

External ID that can be indicated to group multiple connections under the same identifier

Example: "TEST"

Request

JavaScriptCurlPython

const response = await fetch('https://api.finlink.vumi.io/api/v1/queries/connections', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

[
  {
    "credentialsToken": "AAAAA11111",
    "status": "PENDING",
    "errorDetails": {
      "reason": "INTERNAL_SERVER_ERROR",
      "type": "VUMI_ERROR",
      "retryable": false
    },
    "entity": "santander",
    "createdAt": "2024-11-21T07:23:06.619Z",
    "updatedAt": "2024-11-21T07:23:06.619Z",
    "lastSync": "2024-11-21T07:23:06.619Z",
    "updateToken": "123e4567-e89b-12d3-a456-426614174000",
    "twoFactorEnabled": false,
    "hasCredentials": false,
    "externalId": "TEST"
  }
]