Connections

Unlink connection

This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data.

patch/companies/{companyId}/connections/{connectionId}

Path parameters

companyIdstring uuid required

Unique identifier for your SMB in Codat.

Example:8a210b68-6988-11ed-a1eb-0242ac120002

Unique identifier for a company.

connectionIdstring uuid required

Unique identifier for a company's data connection.

Example:2e9d2c44-f675-40ba-8049-353bfcb5e171

Unique identifier for a connection.

Request body

statusDataConnectionStatus — unresolved $ref

Response

idSchema required— unresolved $ref

integrationIdstring uuid required

A Codat ID representing the integration.

integrationKeystring

A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future.

sourceIdstring uuid required

A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, sourceId is associated with a specific bank and has a many-to-one relationship with the integrationId.

The type of platform of the connection.

platformNamestring required

Name of integration connected to company.

linkUrlstring uri required

The link URL your customers can use to authorize access to their business application.

statusDataConnectionStatus required— unresolved $ref

lastSyncCreated — unresolved $ref

createdstring required

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
Unqualified local time: 2021-11-15T01:00:00
UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

dataConnectionErrorsDataConnectionError[] nullable— unresolved $ref

connectionInfoobject nullable

Example response

{
  "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
  "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
  "integrationKey": "dfxm",
  "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
  "platformName": "Basiq",
  "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
  "status": "Linked",
  "lastSync": "2022-10-27T10:22:43.6464237Z",
  "created": "2022-10-27T09:53:29Z",
  "sourceType": "Banking"
}

Changes

Changed in 5 of the 52 revisions of this API.412

Apr 15, 2026v111921220fc251See the full diff
- ▲
  the response property integrationKey became optional for the status 200
  response-property-became-optional
Sep 26, 2024v12085592799f91See the full diff
- ▲
  the response property dataConnectionErrors became nullable for the status 200
  response-property-became-nullable
Sep 23, 2024v1835ae55c88042See the full diff
- ▲
  the response property connectionInfo became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property lastSync became nullable for the status 200
  response-property-became-nullable
Sep 23, 2024v117a793e850811See the full diff
- ●
  removed the optional property additionalProperties from the response with the 200 status
  response-optional-property-removed
May 24, 2024v188bd093eb2272See the full diff
- ○
  added the optional property dataConnectionErrors/items/resolvedOnUtc to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property dataConnectionErrors/items/status to the response with the 200 status
  response-optional-property-added

Full history