API Referencev1Connections

Reinitiate connection

Reinitiate an existing connection to get new credentials

Path parameters

connectedAccountIdstringRequiredformat: "[^\/#\?]+?"

Headers

x-api-keystringRequired

Request

ReinitiateConnectionPayloadDto
dataobjectRequired
The data required to initiate a connection. Structure varies by integration type.
redirectUristringOptional
The URL to redirect to after the connection is successfully initiated.

Response

Reinitiate an existing connection
connectionStatusstring>=1 character
The current status of the initiated connection.
connectedAccountIdstring>=1 character
The ID of the newly created connected account.
redirectUrlstring or null
URL to redirect to for completing the connection process, if required.