Compliance notifications (v2)

Introduction

Bastion sends these notifications when identities and accounts in your organization gain or lose the ability to transact for compliance reasons. There is a single type of event trigger for compliance notifications:

identity_status_update events: Sent whenever an identity (and its associated accounts) undergoes a change in status. These can happen for various reasons:
- During onboarding, Bastion initiates compliance checks for an identity when it receives a Submit Compliance Data request. The event returns updates to the status, or indicates if an RFI is required.
- Throughout the customer lifecycle post-onboarding, a change in identity status can occur. For example, an identity could move from ACTIVE to SUSPENDED.

Identity status update events

An example identity_status_update event payload of an identity that has completed onboarding is as follows:

{
  "id": "01HZXISMEVT_KYB_ACTIVE001",
  "type": "identity_status_update",
  "data": {
    "identity": {
      "id": "01HZXBUSINESSIDENTITY0001",
      "label": "corp_acme_001",
      "identity_type": "BUSINESS",
      "status": "ACTIVE",
      "sub_status": ""
    },
    "affected_account_ids": [],
    "status_reason": null,
    "previous_status": "PENDING_ONBOARDING",
    "previous_sub_status": "COMPLIANCE_CHECKS_IN_PROGRESS"
  }
}

An example identity_status_update event payload of an approved identity that has been suspended is as follows:

{
  "id": "01HZXISMEVT_KYB_ACTIVE001",
  "type": "identity_status_update",
  "data": {
    "identity": {
      "id": "01HZXBUSINESSIDENTITY0001",
      "label": "corp_acme_001",
      "identity_type": "BUSINESS",
      "status": "SUSPENDED",
      "sub_status": ""
    },
    "affected_account_ids": [],
    "status_reason": null,
    "previous_status": "ACTIVE",
    "previous_sub_status": ""
  }
}

Field	Type	Description
`id`	string	Unique identifier for each event. It can be used to deduplicate events.
`type`	string	The type of event. This is always `identity_status_update` for identity status transition events.
`data.identity`	object	The updated identity, including its `id`, `label`, `identity_type`, `status`, and `sub_status`.
`data.affected_account_ids`	array	Account IDs whose derived account status may change because of this identity transition (often empty or a small list).
`data.status_reason`	string \| null	Reason for the status change; `null` unless applicable.
`data.previous_status`	string	The identity’s lifecycle status before this transition.
`data.previous_sub_status`	string \| null	The identity’s sub-status before this transition.

Authentication

API Reference

Webhooks

Compliance notifications (v2)

Introduction

Identity status update events

​Introduction

​Identity status update events

Introduction

Identity status update events