Reference
Company lifecycle and transfers, platform users, access requests from your users, embed sessions. Samples show the envelope; data.object of an event that has a snapshot carries the object's fields as of the event (shown here with its type and id). See the envelope.
company.archived#
A closed company was archived: users removed, consents revoked, retention date set.
Object: company.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b10",
"object": "event",
"type": "company.archived",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1000",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Company",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
},
"details": {
"companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"externalId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"by": "platform",
"from": "active",
"to": "active",
"retentionUntil": "2026-03-02",
"forced": false,
"usersRemoved": 1,
"engagementsEnded": 1,
"authorisationsRevoked": 1
}
}
}
company.closed#
A company was closed: obligations end at the effective date; final returns and exports stay possible.
Object: company.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b11",
"object": "event",
"type": "company.closed",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1001",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Company",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
},
"details": {
"companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"externalId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"by": "platform",
"from": "active",
"to": "active",
"effectiveDate": "2026-03-02",
"reason": "example",
"obligationsEnded": 1
}
}
}
company.created#
A company was created for the platform.
Object: company.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b12",
"object": "event",
"type": "company.created",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1002",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Company",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
company.features.updated#
The features available to a company changed (allowance or limits).
Object: company.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b13",
"object": "event",
"type": "company.features.updated",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1003",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Company",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
company.reactivated#
A suspended company was reactivated.
Object: company.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b14",
"object": "event",
"type": "company.reactivated",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1004",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Company",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
},
"details": {
"companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"externalId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"by": "platform",
"from": "active",
"to": "active"
}
}
}
company.reopened#
A closed company was reopened (or an archived one restored as closed by FinBaze).
Object: company.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b15",
"object": "event",
"type": "company.reopened",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1005",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Company",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
},
"details": {
"companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"externalId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"by": "platform",
"from": "active",
"to": "active",
"obligationsRestored": 1,
"obligationsSkipped": 1,
"restored": false
}
}
}
company.requirements.updated#
What a company still has to provide changed (for now: its filing authorisation, tax_*_authorisation). data.details.reason says why.
Object: company.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b16",
"object": "event",
"type": "company.requirements.updated",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1006",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Company",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
company.suspended#
A company was suspended (read-only; no filings, automations or outbound mail).
Object: company.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b17",
"object": "event",
"type": "company.suspended",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1007",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Company",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
},
"details": {
"companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"externalId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"by": "platform",
"from": "active",
"to": "active",
"suspendedBy": "platform",
"reason": "example",
"displayMessage": "example",
"takenOverBy": "finbaze"
}
}
}
company.transfer.cancelled#
A pending transfer was cancelled.
Object: none (the event's own fields).
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b18",
"object": "event",
"type": "company.transfer.cancelled",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1008",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Event",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
},
"details": {
"companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"transferId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"target": "direct"
}
}
}
company.transfer.created#
The company admin started a transfer to another platform or to direct FinBaze.
Object: none (the event's own fields).
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b19",
"object": "event",
"type": "company.transfer.created",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1009",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Event",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
},
"details": {
"companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"externalId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"by": "platform",
"transferId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"target": "direct",
"expiresAt": "example"
}
}
}
company.transferred_in#
A company arrived from another platform. Set up its users and collect consent again.
Object: company.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b20",
"object": "event",
"type": "company.transferred_in",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1010",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Company",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
},
"details": {
"companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"externalId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"transferId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"fromPlatformId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
company.transferred_out#
A company left the platform (to another platform or to direct FinBaze). The last event the platform receives for it.
Object: none (the event's own fields) · delivered to the former owner of a company that moved on.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b21",
"object": "event",
"type": "company.transferred_out",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1011",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": null,
"request": null,
"data": {
"object": {
"__typename": "Event",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
},
"details": {
"companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"externalId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"transferId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"target": "direct"
}
}
}
company.updated#
A company's details changed.
Object: company.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b22",
"object": "event",
"type": "company.updated",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1012",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Company",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
embed_session.used#
An embed session was exchanged for a token.
Object: embed_session.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b23",
"object": "event",
"type": "embed_session.used",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1013",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "EmbedSession",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
platform_user.created#
A platform user was created.
Object: platform_user.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b24",
"object": "event",
"type": "platform_user.created",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1014",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "PlatformUser",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
platform_user.deactivated#
A platform user was deactivated.
Object: platform_user.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b25",
"object": "event",
"type": "platform_user.deactivated",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1015",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "PlatformUser",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
}
}
}
platform_user.deprovisioned#
A platform user was deprovisioned: access removed and every token revoked.
Object: platform_user.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b26",
"object": "event",
"type": "platform_user.deprovisioned",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1016",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "PlatformUser",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34"
},
"details": {
"externalUserId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"anonymised": false,
"companiesRemoved": 1
}
}
}
user.invite_requested#
A company admin asked, in users-and-access, to give someone access. FinBaze sends no invitation and creates no account: the platform decides.
Object: user_access_request.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b27",
"object": "event",
"type": "user.invite_requested",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1017",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Event",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"requestedBy": "example",
"note": "example",
"email": "name@example.com",
"role": "admin"
}
}
}
user.removal_requested#
A company admin asked to remove someone’s access. The access stays until the platform calls removePlatformUserAccess.
Object: user_access_request.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b28",
"object": "event",
"type": "user.removal_requested",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1018",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Event",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"requestedBy": "example",
"note": "example",
"userId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"email": "name@example.com"
}
}
}
user.role_change_requested#
A company admin asked to change a person’s role. Nothing changes until the platform calls setPlatformUserAccess.
Object: user_access_request.
{
"id": "evt_3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b29",
"object": "event",
"type": "user.role_change_requested",
"apiVersion": "2026-11-01",
"created": "2026-03-02T10:00:00.000Z",
"occurredAt": "2026-03-02T09:59:58.000Z",
"sequence": "1019",
"livemode": false,
"platform": "00000000-0000-4000-8000-0000000000aa",
"company": {
"id": "00000000-0000-4000-8000-0000000000bb",
"externalId": "biz-1001"
},
"request": null,
"data": {
"object": {
"__typename": "Event",
"id": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"companyId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"requestedBy": "example",
"note": "example",
"userId": "3f2b1c9e-5a47-4d1e-9c0b-2a6d8e7f1b34",
"email": "name@example.com",
"role": "admin"
}
}
}