Skip to main content

​
Business events

The table below lists the Webhook events for business.
EventDescription
business.updatedTriggered when a business is updated.
business.all_enrichment_completedTriggered when all additional data has been appended to the business.
business.kyb_completedTriggered when KYB (Know Your Business) checks are completed for a business.
business.kyc_completedTriggered when KYC (Know Your Customer) checks are completed for a business.
business.tax_completedTriggered when tax verification is completed for a business.
business.accounting_completedTriggered when an accounting platform is connected to a business.
business.public_records_completedTriggered when public records have been retrieved and examined for a business.

​
business.updated

The update event will dispatch the whole business even if only few fields for a business are updated
{
  "event_type": "business.updated",
  "payload": {
    "id": "81c92b78-9ce1-4ba0-9557-6dce4a5ccbdb",
    "name": "XYZ BIZ",
    "external_id": "EXT-12345-ABC",
    "tin": "XXXXX7204",
    "mcc_id": "5",
    "naics_id": null,
    "naics_code": null,
    "mcc_code": null,
    "mcc_title": null,
    "owners": [
      {
        "id": "f9eef52c-69ca-48ee-a84e-67c1e9656083",
        "ssn": null,
        "email": "[email protected]",
        "first_name": "XYZ",
        "last_name": "ABC",
        "mobile": null,
        "title": null,
        "created_by": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "created_at": "2024-08-01T09:24:36.049Z",
        "updated_by": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "updated_at": "2024-08-01T09:40:40.605Z",
        "owner_type": "CONTROL | BENEFICIARY",
        "address_apartment": null,
        "address_line_1": "3614, Cassopolis Street,",
        "address_line_2": null,
        "address_city": "Elkhart",
        "address_state": "Indiana",
        "address_postal_code": "46514",
        "address_country": "USA",
        "date_of_birth": "2024-08-01",
        "ownership_percentage": 50
      }
    ],
    "address_apartment": "Suite 100",
    "address_line_1": "3614, Cassopolis Street,",
    "address_line_2": null,
    "address_city": "Elkhart",
    "address_state": "Indiana",
    "address_postal_code": "46514",
    "address_country": "USA",
    "created_at": "2024-08-01T09:24:36.049Z",
    "created_by": "dc2bf5c0-8c39-41aa-b1f2-658991a0deb2",
    "updated_at": "2024-08-01T09:40:40.605Z",
    "updated_by": "846ced9e-45ff-44fe-b180-0a54ec1dc5cb",
    "mobile": null,
    "official_website": null,
    "public_website": null,
    "social_account": null,
    "status": "VERIFIED | UNVERIFIED",
    "naics_title": null,
    "industry": {
      "id": 1,
      "name": "Agriculture, Forestry, Fishing and Hunting",
      "code": "agriculture_forestry_fishing_and_hunting",
      "sector_code": "11",
      "created_at": "2024-04-24T17:56:46.034418",
      "updated_at": "2024-04-24T17:56:46.034418"
    },
    "is_monitoring_enabled": "true | false",
    "subscription": {
      "status": "NOT_SUBSCRIBED | SUBSCRIBED | UNSUBSCRIBED | PAYMENT_DECLINED | PAYMENT_FAILED",
      "created_at": "2024-08-01T09:42:20.686Z",
      "updated_at": "2024-09-01T10:45:54.972Z"
    },
    "business_names": [
      {
        "name": "XYZ BIZ",
        "is_primary": true
      }
    ],
    "business_addresses": [
      {
        "line_1": "3614, Cassopolis Street,",
        "apartment": null,
        "city": "Elkhart",
        "state": "Indiana",
        "country": "USA",
        "postal_code": "46514",
        "mobile": null,
        "is_primary": true
      }
    ],
    "formation_date": "2024-08-01T09:24:36.049Z",
    "additional_data": [
      {
        "field": null,
        "label": null,
        "value": null
      }
    ],
    "deposit_accounts": [
      {
        "account_number": "XXXXXXXXX2445",
        "routing_number": null
      }
    ],
    "business_applicants": [
      {
        "email": "[email protected]",
        "first_name": "XYZ",
        "last_name": "ABC"
      }
    ],
    "business_verification_uploads": [
      {
        "url": "www.website.com",
        "file_name": null
      }
    ],
    "entity_type": [
      "CORPORATION"
    ],
    "corporation_type": null,
    "processing_statements": []
  }
}

​
business.all_enrichment_completed

{
  "event_code": "business.all_enrichment_completed",
  "payload": {
    "business_id": "c5bf2bc0-56d9-4e83-9451-556872793e48",
    "case_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "category_name": "ALL",
    "external_id": "EXT-12345-ABC",
  }
}

​
business.kyb_completed | business.kyc_completed | business.tax_completed | business.accounting_completed | business.public_records_completed

{
  "event_code": "business.kyb_completed | business.kyc_completed | business.tax_completed | business.accounting_completed | business.public_records_completed",
  "payload": {
    "business_id": "c5bf2bc0-56d9-4e83-9451-556872793e48",
    "case_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "category_name": "BUSINESS_ENTITY_VERIFICATION | VERIFICATION | TAX | ACCOUNTING | PUBLIC_RECORDS",
  }
}