Webhooks are a mechanism for your software to automatically receive information about events. By leveraging webhooks, you remove the need to poll the API for state changes.
For general information related to webhooks, refer to the Implementing webhooks guide.
To reflect status changes during a business onboarding, we provide the following Business events types:
| Status | Descriptions |
|---|---|
BUSINESS.CREATED | The business has been successfully created and waiting for checks to be completed. |
BUSINESS.ACTIVATED | The business has completed all checks and can actively use the Upvest Investment API. |
BUSINESS.DEACTIVATED | The business has been disabled from using the |
BUSINESS.DATA_CHANGED | Changes to the business information, like email address, is in progress. |
BUSINESS.DATA_CHANGE_FAILED | The attempted change to business information has not been completed. |
BUSINESS.OFFBOARDING_INITIATED | The business offboarding process has started. |
BUSINESS.OFFBOARDED | The business is fully offboarded. |
| Status | Descriptions |
|---|---|
BUSINESS_CHECK.CREATED | A business check has successfully been created. |
BUSINESS_CHECK.PASSED | The business has successfully completed all required checks. |
BUSINESS_CHECK.FAILED | The business check has failed. |
{
"id": "2df83681-6a42-4837-a554-a8197335bcfa",
"created_at": "2021-11-22T09:04:42Z",
"type": "BUSINESS.CREATED",
"object": {
"id": "a9a72268-4f3c-4de2-abb9-a553a3bb7608",
"created_at": "2024-10-24T14:14:22Z",
"updated_at": "2024-10-24T14:14:22Z",
"contact_email": "acme.corporation@example.com",
"registered_address": {
"address_line1": "110",
"address_line2": "Schonhauser Allee",
"postcode": "101110",
"city": "Berlin",
"state": "BE",
"country": "DE"
},
"registration_number": "111221111",
"tax_information": {
"tax_country_code": "DE",
"tax_identification_type": "STEUERNUMMER",
"tax_identification_number": "111213123123",
"is_resident_in_multiple_tax_jurisdictions": false,
"is_subject_to_fatca": false
},
"business_type": "LIMITED_LIABILITY_COMPANY",
"identification": {
"company_name": "Acme Corporation",
"incorporation_date": "2000-10-10",
"district_court": "Berlin Charlottenburg",
"legal_designation": "GESELLSCHAFT_MIT_BESCHRAENKTER_HAFTUNG",
"legal_entity_identifier": "1234567890",
"common_reporting_standards": {
"is_passive_non_financial_entity": false,
"is_financial_institution": false
}
},
"terms_and_conditions": {
"consent_document_id": "6a163d14-5b3d-48be-ac90-43314e96be71",
"confirmed_at": "2024-10-24T14:14:22Z"
},
"data_privacy_and_sharing_agreement": {
"consent_document_id": "fa2227c3-2b29-47e1-84da-996d09517edc",
"confirmed_at": "2024-10-24T14:16:22Z"
},
"status": "ACTIVE"
},
"webhook_id": "1b097e06-8a14-4181-b72a-de0972a3c57b"
}