Get Connection status

Get connection status

Retrieve the status of a given connection if it belongs to the current app

GEThttps://api.finlink.vumi.io/api/v1/queries/connections/{token}

Authorization

bearerAuth

Path parameters

token*string

Token to identify the connection

Response

200401404500

Successfully retrieved connection status

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/{token}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200404

{
  "credentialsToken": "AAAAA11111",
  "status": "PENDING",
  "errorDetails": {
    "reason": "INTERNAL_SERVER_ERROR",
    "type": "VUMI_ERROR",
    "retryable": false
  },
  "entity": "santander",
  "createdAt": "2024-10-22T05:12:06.524Z",
  "updatedAt": "2024-10-22T05:12:06.524Z",
  "lastSync": "2024-10-22T05:12:06.524Z",
  "updateToken": "123e4567-e89b-12d3-a456-426614174000",
  "twoFactorEnabled": false,
  "hasCredentials": false,
  "externalId": "TEST"
}

Data Types

Connection Status

You can find four different statuses when retrieving a connection status:

Status	Description
PENDING	Connection is still importing data for the first time. This status rarely lasts for more than 5 minutes
READY	Last information extraction for the connection was correct. To know when it happenned, look at the lastSync field
UPDATING	Connection information is currently being updated. Typically related to manual updates.
ERRORED	Last information extraction encountered an error. To know more about it, look at errorDetails field.

Error reason

Found inside the errorDetails object, it indicates the reason for the error happenning

Error type