Get Connection status

Get connection status

get

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

Authorizations
Path parameters
tokenstringRequired

Token to identify the connection

Responses
200
Successfully retrieved connection status
application/json
get
GET /api/v1/queries/connections/{token} HTTP/1.1
Host: api.finlink.vumi.io
Authorization: Bearer JWT
Accept: */*

{
  "credentialsToken": "AAAAA11111",
  "status": "PENDING",
  "errorDetails": {
    "reason": "INTERNAL_SERVER_ERROR",
    "type": "VUMI_ERROR",
    "retryable": true
  },
  "entity": "santander",
  "createdAt": "2025-07-04T00:09:15.532Z",
  "updatedAt": "2025-07-04T00:09:15.532Z",
  "lastSync": "2025-07-04T00:09:15.532Z",
  "updateToken": "123e4567-e89b-12d3-a456-426614174000",
  "restoreToken": "123e4567-e89b-12d3-a456-426614174000",
  "twoFactorEnabled": true,
  "hasCredentials": true,
  "externalId": "customer-123"
}

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

Information extraction encountered an error, and there is no more information available (the connection is empty or missing critical information). To know more about why the error happenned, look at errorDetails field.

UPDATE_ERROR

The connection encountered an error during last information update butthere is information available from an older update (that will not be completely updated). To know more about why the error happenned, look at errorDetails field.

Error reason

Found inside the errorDetails object, it indicates the reason for the current ERRORED or UPDATE_ERROR status. Errors might happen due to a variety of reasons, from Vumi Finlink's problems to entity problems (the financial entity was down at that moment), or even statuses that indicate that something might need to be done to restore the connection. This is the list of error reasons you will encounter:

Reason
Description

INTERNAL_SERVER_ERROR

An error that happenned in an uncontrolled way, causing the connection to fail

UNKNOWN_ERROR

An external error that happenned but we can't be certain of what caused it

PROVIDER_UNAVAILABLE

The financial provider was unavailable at the time of the connection or update

INCORRECT_CREDENTIALS

The user changed credentials in a recurrent connection and needs to update them

SECOND_FACTOR_NEEDED

The second factor needs a refresh to be able to continue accessing the financial entity

BLOCKED_USER

The user account is blocked, and it need to be unblocked by them before restoring Finlink's access to it

Last updated