Account Status

Account Submitted

Triggered when an account application is first submitted for verification.

Description

Sent when a new account application is submitted and awaiting verification.

📦 Event Details

id string

Unique event identifier.

name string

Event name: account.submitted.

account_id string

Unique identifier of the related account.

data object

Additional event payload. Empty object for this event.

created_at string

ISO 8601 timestamp indicating when the event was created.

version string

API version associated with the event.

Request Body Example

{
  "id": "evt_UVU43_95Onav3lShzYmSVw",
  "name": "account.submitted",
  "account_id": "acct_wUwt_u52MDCIvG8KqbC1YA",
  "data": {},
  "created_at": "2025-04-23T06:16:35+0000",
  "version": "2025-02-14"
}

Account Active

Triggered when an account becomes active after successful verification.

Description

Sent when an account has completed verification and is now active for transactions.

📦 Event Details

id string

Unique event identifier.

name string

Event name: account.active.

account_id string

Unique identifier of the activated account.

data object

Event payload containing account-related details.

account_details object

Details of the activated account.

business_details object

Business information associated with the account.

address object

Primary registered business address.

address_line1 string

Address line 1.

suburb string

Suburb or locality.

state string

State or region.

postcode string

Postal or ZIP code.

country_code string

Country code (2-letter ISO 3166-2).

address_english object

English representation of the business address.

country_code string

Country code (2-letter ISO 3166-2).

postcode string

Postal or ZIP code.

as_trustee boolean

Indicates whether the business operates as a trustee.

business_address object

Alternate business address details.

address_line1 string

Business address line 1.

created_at string

ISO 8601 timestamp indicating when the event was created.

version string

API version associated with the event.

Request Body Example

{
  "id": "evt_iLMoFQxuM4iEc3XPwIqxmw",
  "name": "account.active",
  "account_id": "acct_wUwt_u52MDCIvG8KqbC1YA",
  "data": {
    "account_details": {
      "business_details": {
        "address": {
          "address_line1": "3837 Violette Knolls",
          "suburb": "Fadelton",
          "country_code": "US",
          "postcode": "58888",
          "state": "FL"
        },
        "address_english": {
          "country_code": "US",
          "postcode": "58888"
        },
        "as_trustee": false,
        "business_address": {
          "address_line1": "44583 Gislason Trail"
        }
      }
    }
  },
  "created_at": "2025-04-23T06:16:35+0000",
  "version": "2025-02-14"
}

Account Suspended

Triggered when account verification fails or is suspended.

Description

Sent when an account fails verification or is suspended for compliance reasons.

📦 Event Details

id string

Unique event identifier.

name string

Event name: account.suspended.

account_id string

Unique identifier of the suspended account.

data object

Event payload containing suspension and account details.

account_details object

Details of the suspended account.

business_details object

Business information associated with the account.

address object

Primary registered business address.

address_line1 string

Address line 1.

suburb string

Suburb or locality.

state string

State or region.

postcode string

Postal or ZIP code.

country_code string

Country code (2-letter ISO 3166-2).

business_name string

Registered legal name of the business.

tax_id object

Business tax identification details.

number string

Tax identification number.

type string

Type of tax identifier (e.g., EIN).

status string

Current account status. Value: SUSPENDED.

created_at string

ISO 8601 timestamp indicating when the event was created.

version string

API version associated with the event.

Request Body Example

{
  "id": "evt_l_NMv9_MPDGZqP-5Z9vHlw",
  "name": "account.suspended",
  "account_id": "acct_wUwt_u52MDCIvG8KqbC1YA",
  "data": {
    "account_details": {
      "business_details": {
        "address": {
          "address_line1": "44583 Gislason Trail",
          "suburb": "New Tryciaburgh",
          "country_code": "US",
          "postcode": "58888",
          "state": "FL"
        },
        "business_name": "Bartell and Sons US",
        "tax_id": {
          "number": "123456789",
          "type": "EIN"
        }
      }
    },
    "status": "SUSPENDED"
  },
  "created_at": "2025-04-23T09:46:48+0000",
  "version": "2025-02-14"
}

Account Action Required

Triggered when additional information is needed to complete account verification.

Description

Sent when the verification process cannot be completed without additional action or documentation from the user.

📦 Event Details

id string

Unique event identifier.

name string

Event name: rfi.action_required.

account_id string

Unique identifier of the account requiring action.

data object

Event payload containing RFI details.

id string

Unique identifier of the RFI request.

type string

Type of action required. Allowed values:

• KYC – Know Your Customer documentation required
• AML – Anti-Money Laundering verification
• ADDRESS – Proof of address required
• IDENTITY – Identity verification required

created_at string

ISO 8601 timestamp indicating when the event was created.

version string

API version associated with the event.

Request Body Example

{
  "id": "8be6af0f-f946-4b2d-ab4c-a04e66cfe82a",
  "name": "rfi.action_required",
  "account_id": "acct_5zJ0AJ2HMHKKvUGZf6os8w",
  "data": {
    "id": "89362bcb-0fbc-41ab-ae57-2cb7c3d8dbec",
    "type": "KYC"
  },
  "created_at": "2025-04-23T10:23:36+0000",
  "version": "2025-02-14"
}