Retrieve connect request
Returns the latest connection request you started for this integration with
POST /integrations/{key}/connect. Poll it to follow the connection; it never changes
anything. Follow each response’s instructions.
Authorizations
API key prefixed with finta_
Path Parameters
The integration's key from GET /integrations, e.g. mercury.
Response
The latest connection request for this integration.
connect_request The integration's key.
"mercury"
reconnect re-authenticates an existing connection whose status is requires_reconnect.
connect, reconnect 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.
pending, authorizing, complete, failed, expired "pending"
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.
"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"
Unix timestamp (seconds) after which the link stops working.
1790170200
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.
access_denied, provider_admin_required, provider_error, connection_failed Plain-language next steps for the current status, including how often to poll.