# Business events

Notifies subscribers of business lifecycle events.
Triggered when a business is created, activated, deactivated, offboarded, or has a data change processed or rejected.
See the Business accounts guide ([TOL](https://docs.upvest.co/products/tol/guides/accounts/businesses_overview) / [BYOL](https://docs.upvest.co/products/byol/guides/accounts/businesses_overview)) for business account types.

Endpoint: POST Business events
Version: 1.144.0

## Request fields (application/json):

  - `id` (string, required)
    Event unique identifier

  - `created_at` (string, required)
    Date and time when the event was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)

  - `type` (string, required)
    Event type indicating the business lifecycle change
    Enum: "BUSINESS.CREATED", "BUSINESS.ACTIVATED", "BUSINESS.DEACTIVATED", "BUSINESS.DATA_CHANGED", "BUSINESS.DATA_CHANGE_FAILED", "BUSINESS.OFFBOARDING_INITIATED", "BUSINESS.OFFBOARDED"

  - `object` (any, required)
    The object the event relates to: the business for lifecycle events, or a failure object for `BUSINESS.DATA_CHANGE_FAILED` events

  - `object.id` (string, required)
    Unique identifier for the business.

  - `object.created_at` (string, required)
    Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)

  - `object.updated_at` (string, required)
    Date and time when the resource was last updated. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html)

  - `object.contact_email` (string, required)
    Contact email address of the business.

  - `object.registered_address` (object, required)
    Address. Must not be a P.O. box or c/o address.

  - `object.registered_address.address_line1` (string, required)
    First address line of the address.

  - `object.registered_address.address_line2` (string)
    Second address line of the address.

  - `object.registered_address.postcode` (string, required)
    Postal code (postcode, PIN or ZIP code)

  - `object.registered_address.country` (string, required)
    Accepted country code. [ISO 3166-1 alpha-2 codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
    Enum: "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW"

  - `object.registered_address.state` (string)
    State, province, county. [ISO 3166 alpha-2 Codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).

  - `object.registered_address.city` (string, required)

  - `object.registration_number` (string)
    Registration number of the business.

  - `object.tax_information` (object, required)
    Tax information of the business.

  - `object.tax_information.tax_country_code` (string, required)
    Accepted country code. [ISO 3166-1 alpha-2 codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
    Enum: "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW"

  - `object.tax_information.tax_identification_type` (string, required)
    Type of tax identification used by the business.
    Enum: "STEUERNUMMER", "WIRTSCHAFTSIDENTIFIKATIONSNUMMER"

  - `object.tax_information.tax_identification_number` (string, required)
    Tax identification number of the business.
When `tax_identification_type` is `STEUERNUMMER`, the value is 10 or 11 digits, provided either as bare digits or in a state-specific slash-grouped layout. Slashes are all-or-nothing and must appear at the grouping positions:
| Format | Grouping | Example |
|  --- | --- | --- |
| Bare digits | 10 or 11 digits | `1234567890`, `12345678901` |
| North Rhine-Westphalia | 3/4/4 | `133/8150/8159` |
| Bavaria | 3/3/5 | `181/815/08155` |
| Standard 10-digit | 2/3/5 | `24/815/08151` |
| Alternative 10-digit (Berlin, Bremen, Lower Saxony) | 3/3/4 | `181/815/0815` |

When `tax_identification_type` is `WIRTSCHAFTSIDENTIFIKATIONSNUMMER`, the value is `DE` followed by 9 digits, with an optional 5-digit distinguishing feature (for example `DE123456789` or `DE123456789-00001`).

  - `object.tax_information.is_resident_in_multiple_tax_jurisdictions` (boolean, required)
    Indicates if the business is resident in multiple tax jurisdictions.

  - `object.tax_information.is_subject_to_fatca` (boolean, required)
    Indicates if the business is subject to FATCA regulations.

  - `object.business_type` (string, required)
    Type of the business.
    Enum: "LIMITED_LIABILITY_COMPANY"

  - `object.identification` (object, required)
    Identification information of the business.

  - `object.identification.company_name` (string, required)
    Name of the company.

  - `object.identification.incorporation_date` (string, required)
    Incorporation date of the business in YYYY-MM-DD format. [RFC 3339, section 5.6](https://json-schema.org/draft/2020-12/json-schema-validation.html#RFC3339)

  - `object.identification.district_court` (string)
    District court where the company is registered.

  - `object.identification.legal_designation` (string, required)
    Country specific legal designation of the company.
    Enum: "GESELLSCHAFT_MIT_BESCHRAENKTER_HAFTUNG", "UNTERNEHMERGESELLSCHAFT", "AKTIENGESELLSCHAFT"

  - `object.identification.legal_entity_identifier` (string)
    Legal Entity Identifier (LEI) of the company. A 20-character alphanumeric code as defined by [ISO 17442](https://en.wikipedia.org/wiki/Legal_Entity_Identifier).

  - `object.identification.common_reporting_standards` (object, required)
    Common reporting standards information.

  - `object.identification.common_reporting_standards.is_passive_non_financial_entity` (boolean, required)
    Indicates if the company is a passive non-financial entity.

  - `object.identification.common_reporting_standards.is_financial_institution` (boolean, required)
    Indicates if the company is a financial institution.

  - `object.terms_and_conditions` (object, required)
    Terms and conditions agreement.

  - `object.terms_and_conditions.consent_document_id` (string, required)
    UUID of the consent document.

  - `object.terms_and_conditions.confirmed_at` (string, required)
    Timestamp when the terms and conditions were confirmed.

  - `object.data_privacy_and_sharing_agreement` (object, required)
    Data privacy and sharing agreement.

  - `object.data_privacy_and_sharing_agreement.consent_document_id` (string, required)
    UUID of the data privacy and sharing agreement document.

  - `object.data_privacy_and_sharing_agreement.confirmed_at` (string, required)
    Timestamp when the data privacy and sharing agreement was confirmed.

  - `object.status` (string, required)
    Status of the business.
* ACTIVE -
* INACTIVE -
* OFFBOARDING -
* OFFBOARDED -
    Enum: "ACTIVE", "INACTIVE", "OFFBOARDING", "OFFBOARDED"

  - `object.business_type` (string, required)
    Type of the business. Always `SOLE_TRADER` for sole trader businesses.

  - `object.identification` (object, required)
    Identification information of the sole trader business.

  - `object.identification.company_name` (string, required)
    Name of the sole trader business.

  - `object.identification.legal_designation` (string, required)
    Country specific legal designation of the sole trader business.
    Enum: "EINZELUNTERNEHMER", "FREIBERUFLER", "EINGETRAGENER_KAUFMANN", "EINGETRAGENE_KAUFFRAU"

  - `object.business_id` (string, required)
    Event unique identifier

  - `object.reason` (string, required)
    The reason why the data change failed.

  - `webhook_id` (string, required)
    Webhook unique identifier.