> For the complete documentation index, see [llms.txt](https://docs.kick.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.kick.co/api/api-reference/plaid-connections.md).

# Plaid Connections

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

> 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\`.

```json
{"openapi":"3.0.2","info":{"title":"Kick Platform API","version":"v1"},"servers":[{"description":"Production","url":"https://use.kick.co/api"}],"security":[{"organizationAccessToken":[]}],"components":{"securitySchemes":{"organizationAccessToken":{"description":"Organization access token issued by Kick, sent as `Authorization: Bearer kick_org_...`.","scheme":"bearer","type":"http"}}},"paths":{"/platform/v1/plaid-connections":{"get":{"description":"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`.","operationId":"plaidConnections.listConnections","parameters":[{"in":"query","name":"limit","schema":{"default":100,"maximum":100,"minimum":1,"type":"integer"}},{"in":"query","name":"offset","schema":{"default":0,"minimum":0,"nullable":true,"type":"integer"}},{"in":"query","name":"workspaceId","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"entityIds","schema":{"items":{"format":"uuid","type":"string"},"minItems":1,"nullable":true,"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"properties":{"accounts":{"items":{"properties":{"accountNumberMask":{"description":"Last digits of the account number, as Plaid reports them.","nullable":true,"type":"string"},"createdAt":{"format":"date-time","type":"string"},"entityId":{"format":"uuid","type":"string"},"id":{"format":"uuid","type":"string"},"name":{"nullable":true,"type":"string"},"type":{"enum":["checking","savings","credit_card","loan","line_of_credit","investment","payment_processor","cash","other"],"type":"string"}},"required":["id","entityId","name","accountNumberMask","type","createdAt"],"type":"object"},"type":"array"},"connection":{"properties":{"createdAt":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"},"institutionId":{"description":"Plaid institution id, null when Plaid reports none.","nullable":true,"type":"string"},"institutionName":{"type":"string"}},"required":["id","institutionName","institutionId","createdAt"],"type":"object"}},"required":["connection","accounts"],"type":"object"},"type":"array"},"pagination":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"}},"required":["limit","offset","total"],"type":"object"}},"required":["data","pagination"],"type":"object"}}},"description":"200"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"400"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"401"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"404"},"429":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"429"}},"summary":"List Plaid connections","tags":["plaidConnections"]}}}}
```

## Create a Plaid connection

> 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\`.

```json
{"openapi":"3.0.2","info":{"title":"Kick Platform API","version":"v1"},"servers":[{"description":"Production","url":"https://use.kick.co/api"}],"security":[{"organizationAccessToken":[]}],"components":{"securitySchemes":{"organizationAccessToken":{"description":"Organization access token issued by Kick, sent as `Authorization: Bearer kick_org_...`.","scheme":"bearer","type":"http"}}},"paths":{"/platform/v1/plaid-connections":{"post":{"description":"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`.","operationId":"plaidConnections.createConnection","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"properties":{"entityId":{"format":"uuid","type":"string"},"processorToken":{"maxLength":200,"pattern":"^processor-(sandbox|development|production)-[0-9a-zA-Z]+(-[0-9a-zA-Z]+)*$","type":"string"}},"required":["entityId","processorToken"],"type":"object"}}},"description":"Body"},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"account":{"properties":{"accountNumberMask":{"description":"Last digits of the account number, as Plaid reports them.","nullable":true,"type":"string"},"createdAt":{"format":"date-time","type":"string"},"entityId":{"format":"uuid","type":"string"},"id":{"format":"uuid","type":"string"},"name":{"nullable":true,"type":"string"},"type":{"enum":["checking","savings","credit_card","loan","line_of_credit","investment","payment_processor","cash","other"],"type":"string"}},"required":["id","entityId","name","accountNumberMask","type","createdAt"],"type":"object"},"connection":{"properties":{"createdAt":{"format":"date-time","type":"string"},"id":{"format":"uuid","type":"string"},"institutionId":{"description":"Plaid institution id, null when Plaid reports none.","nullable":true,"type":"string"},"institutionName":{"type":"string"}},"required":["id","institutionName","institutionId","createdAt"],"type":"object"}},"required":["connection","account"],"type":"object"}}},"description":"201"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"400"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"401"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"404"},"429":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"429"}},"summary":"Create a Plaid connection","tags":["plaidConnections"]}}}}
```

## Delete a Plaid connection

> 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\`.

```json
{"openapi":"3.0.2","info":{"title":"Kick Platform API","version":"v1"},"servers":[{"description":"Production","url":"https://use.kick.co/api"}],"security":[{"organizationAccessToken":[]}],"components":{"securitySchemes":{"organizationAccessToken":{"description":"Organization access token issued by Kick, sent as `Authorization: Bearer kick_org_...`.","scheme":"bearer","type":"http"}}},"paths":{"/platform/v1/plaid-connections/{connectionId}":{"delete":{"description":"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`.","operationId":"plaidConnections.deleteConnection","parameters":[{"in":"path","name":"connectionId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"description":"200"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"400"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"401"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"404"},"409":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"409"},"429":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"traceId":{"nullable":true,"type":"string"}},"required":["message"],"type":"object"}}},"description":"429"}},"summary":"Delete a Plaid connection","tags":["plaidConnections"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.kick.co/api/api-reference/plaid-connections.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.