Skip to main content

Connection

A partner app connection and its current status

connectionIdstring<uuid>

Unique identifier of the connection

partnerAccountIdstring<uuid>

Account id of the partner that owns the connection

customerAccountIdstring<uuid>

Account id of the connected customer, once accepted

statusstring

Current status of the connection

Possible values: [PENDING, ACTIVE, DECLINED, REVOKED, EXPIRED]

Example: ACTIVE
expiresAtstring<date-time>

When a pending connection request expires

Example: 2026-01-01T00:00:00Z
acceptedAtstring<date-time>

When the customer accepted the connection

Example: 2026-01-01T00:00:00Z
revokedAtstring<date-time>

When the connection was revoked

Example: 2026-01-01T00:00:00Z
revokedBystring

Who revoked the connection

createdAtstring<date-time>

When the connection was created

Example: 2026-01-01T00:00:00Z
Connection
{
  "connectionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "partnerAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "customerAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "ACTIVE",
  "expiresAt": "2026-01-01T00:00:00Z",
  "acceptedAt": "2026-01-01T00:00:00Z",
  "revokedAt": "2026-01-01T00:00:00Z",
  "revokedBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}