POST
/
disconnect
import Finch from '@tryfinch/finch-api';

const finch = new Finch();

async function main() {
  const disconnectResponse = await finch.account.disconnect();

  console.log(disconnectResponse.status);
}

main();
{
  "status": "success"
}

Deletion is based on both the employer and provider of the access_token used to call this endpoint, and will also delete all tokens with the same employer/provider pair. Other tokens for the same employer, but connected to a different provider, require a separate call.

We require applications to implement the Disconnect endpoint for billing and security purposes.

Authorizations

Authorization
string
headerrequired

Please use your Access Token

Headers

Finch-API-Version
string
default: 2020-09-17required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Response

200 - application/json
status
string

If the request is successful, Finch will return “success” (HTTP 200 status).