See what's new in the
Kick Changelog
Ctrlk
Go to Kick
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Plaid Connections

Open a bank connection from a Plaid processor token, list the connections your integration created, and delete one.

Your integration runs the Plaid Link flow under its own Plaid credentials and hands Kick the resulting processor_token, so there is no link token or public token to exchange here. The processor token has to point at exactly one credit, depository, or loan account denominated in USD, and entityId says which entity that account belongs to.

Only connections your integration created are visible on this surface. Connections a user linked themselves in Kick are never listed and cannot be deleted through the API.

Deleting a connection removes its accounts and their transactions along with it. An account carrying manual journal entries cannot be removed, so the request is rejected with 409.

List Plaid connections

get

Returns the connections the partner created in a workspace, newest first, together with their accounts. Connections a user linked themselves are never listed. Results are paged with limit/offset.

Authorizations
AuthorizationstringRequired

Organization access token issued by Kick, sent as Authorization: Bearer kick_org_....

Query parameters
limitinteger · min: 1 · max: 100OptionalDefault: 100
offsetinteger · nullableOptionalDefault: 0
workspaceIdstring · uuidRequired
entityIdsstring · uuid[] · min: 1 · nullableOptional
Responses
200

200

application/json
get/platform/v1/plaid-connections
GET /api/platform/v1/plaid-connections?workspaceId=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: use.kick.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "accounts": [
        {
          "accountNumberMask": "text",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "entityId": "123e4567-e89b-12d3-a456-426614174000",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "type": "checking"
        }
      ],
      "connection": {
        "createdAt": "2026-01-01T00:00:00.000Z",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "institutionId": "text",
        "institutionName": "text"
      }
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 1,
    "total": 1
  }
}

Create a Plaid connection

post

Creates a connection from a Plaid processor_token the partner obtained through its own Plaid Link flow. The token must point at exactly one credit, depository or loan account denominated in USD, and that account is created already assigned to entityId.

Authorizations
AuthorizationstringRequired

Organization access token issued by Kick, sent as Authorization: Bearer kick_org_....

Header parameters
Idempotency-Keystring · min: 1 · max: 255Optional

A unique key that makes the request idempotent. Retrying with the same key within 24 hours replays the original response (marked with Idempotent-Replayed: true) instead of executing again.

Body
entityIdstring · uuidRequired
processorTokenstring · max: 200RequiredPattern: ^processor-(sandbox|development|production)-[0-9a-zA-Z]+(-[0-9a-zA-Z]+)*$
Responses
201

201

application/json
post/platform/v1/plaid-connections
POST /api/platform/v1/plaid-connections HTTP/1.1
Host: use.kick.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "entityId": "123e4567-e89b-12d3-a456-426614174000",
  "processorToken": "text"
}
{
  "account": {
    "accountNumberMask": "text",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "entityId": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "type": "checking"
  },
  "connection": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "institutionId": "text",
    "institutionName": "text"
  }
}

Delete a Plaid connection

delete

Deletes a connection the partner created, together with its accounts and their transactions. A connection outside the organization's book of business, or one the partner did not create, reads as not found. An account carrying manual journal entries cannot be deleted and answers 409.

Authorizations
AuthorizationstringRequired

Organization access token issued by Kick, sent as Authorization: Bearer kick_org_....

Path parameters
connectionIdstring · uuidRequired
Header parameters
Idempotency-Keystring · min: 1 · max: 255Optional

A unique key that makes the request idempotent. Retrying with the same key within 24 hours replays the original response (marked with Idempotent-Replayed: true) instead of executing again.

Responses
200

200

No content
delete/platform/v1/plaid-connections/{connectionId}
DELETE /api/platform/v1/plaid-connections/{connectionId} HTTP/1.1
Host: use.kick.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousChart of Accounts
NextTransactions

Last updated

Was this helpful?