Skip to main content
POST
Refresh a bank connection

Authorizations

Authorization
string
header
required

A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.

Path Parameters

client
string
required

The client id, from list_clients.

Required string length: 1 - 60
connection
string
required

The connection id, from list_connections.

Required string length: 1 - 60

Body

application/json

The body is of type object.

Response

Success.

object
enum<string>
required
Available options:
connection
id
string
required
institution
string
required
institution_id
string | null
required
logo_url
string | null
required
status
enum<string>
required
Available options:
pending,
active,
needs_reconnect,
expired,
revoked
person_name
string | null
required

Who connected it in the portal.

created_at
string
required

An ISO 8601 time in UTC.

An ISO 8601 time in UTC.

last_refreshed_at
string | null
required

An ISO 8601 time in UTC.

ended_at
string | null
required

An ISO 8601 time in UTC.