Skip to main content
GET
Retrieve connect request

Authorizations

Authorization
string
header
required

API key prefixed with finta_

Path Parameters

key
string
required

The integration's key from GET /integrations, e.g. mercury.

Response

The latest connection request for this integration.

object
enum<string>
required
Available options:
connect_request
integration
string
required

The integration's key.

Example:

"mercury"

intent
enum<string>
required

reconnect re-authenticates an existing connection whose status is requires_reconnect.

Available options:
connect,
reconnect
status
enum<string>
required

pending until the provider sends the user back, then authorizing while Finta finishes the connection, then complete or failed. expired when nobody finished the link before expires_at. A request already authorizing when expires_at passes stays authorizing while Finta finishes it.

Available options:
pending,
authorizing,
complete,
failed,
expired
Example:

"pending"

url
string<uri> | null
required

The provider's authorization page. A person opens it in a browser signed in to Finta as the API key's owner. Single use. null unless status is pending.

Example:

"https://oauth2.mercury.com/oauth2/auth?client_id=example&redirect_uri=https%3A%2F%2Fapp.finta.com%2Fintegrations%2Fmercury%2Fcallback&response_type=code&scope=offline_access+read&state=example"

expires_at
integer
required

Unix timestamp (seconds) after which the link stops working.

Example:

1790170200

failure_code
enum<string> | null
required

Why a failed request failed; null for every other status. access_denied: the user declined at the provider. provider_admin_required: the provider account that approved is not an administrator. provider_error: the provider returned an error or no authorization code. connection_failed: Finta could not finish the connection.

Available options:
access_denied,
provider_admin_required,
provider_error,
connection_failed
instructions
string
required

Plain-language next steps for the current status, including how often to poll.