Skip to main content
DELETE
Revoke a publisher, retaining or discarding imported financial history

Authorizations

X-Api-Key
string
header
required

API key for authentication. Generate one from your account settings.

Path Parameters

id
string<uuid>
required

Query Parameters

disposition
enum<string>

What happens to the data this connection imported. retain (the default) keeps every account, balance and transaction. discard removes them: accounts FinanceKit created are destroyed, accounts it was linked to are emptied of FinanceKit-sourced entries and rebalanced, and source identities, balance observations and conflicts are deleted. Irreversible, and it removes imported entries the family later reconciled, excluded or edited. Supported dispositions are advertised by GET /api/v1/financekit/capabilities.

Available options:
retain,
discard

Response

Publisher revoked, discard of imported history accepted

id
string<uuid>
required
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
connection_id
string<uuid>
required
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
publisher_id
string<uuid>
required
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
status
enum<string>
required
Available options:
pending_mapping,
active,
repair_required,
revoked
generation
integer
required
Required range: x >= 1
next_sequence
integer
required
Required range: x >= 1
open_conflicts
integer
required
Required range: x >= 0
stream_id
string<uuid> | null
Pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$
repair_reason
string | null
last_device_contact_at
string<date-time> | null
last_accepted_at
string<date-time> | null
last_imported_at
string<date-time> | null
last_downstream_at
string<date-time> | null
last_captured_at
string<date-time> | null
accounts
object[]
pagination
object
purge_requested_at
string<date-time> | null
purge_completed_at
string<date-time> | null
disposition
enum<string>
Available options:
retain,
discard