{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["tabs","tab","code-snippet"]},"type":"markdown"},"seo":{"title":"Business webhooks","description":"Welcome to the Upvest API documentation. Here you will find all the information you need to integrate with our API.","siteUrl":"https://docs.upvest.co/","image":"/assets/upvest-logo-card.ee25ccc59849324b0b73151a5c972c87639419556344db0b6dcf518151cb4c3c.925ff8b2.png","keywords":"documentation, api","lang":"en-US","meta":[{"name":"description","content":"Welcome to the Upvest API documentation. Here you will find all the information you need to integrate with our API."},{"name":"image","content":"/assets/upvest-logo-card.ee25ccc59849324b0b73151a5c972c87639419556344db0b6dcf518151cb4c3c.925ff8b2.png"},{"name":"twitter:card","content":"summary_large_image"},{"name":"twitter:title","content":"Welcome to the Upvest API Documentation"},{"name":"twitter:image","content":"/assets/upvest-logo-card.ee25ccc59849324b0b73151a5c972c87639419556344db0b6dcf518151cb4c3c.925ff8b2.png"},{"name":"twitter:description","content":"Welcome to the Upvest API documentation. Here you will find all the information you need to integrate with our API."},{"name":"og:url","content":"https://docs.upvest.co/"},{"name":"og:title","content":"Welcome to the Upvest API Documentation"},{"name":"og:description","content":"Welcome to the Upvest API documentation. Here you will find all the information you need to integrate with our API."},{"name":"og:image","content":"/assets/upvest-logo-card.ee25ccc59849324b0b73151a5c972c87639419556344db0b6dcf518151cb4c3c.925ff8b2.png"}],"llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"business-webhooks","__idx":0},"children":["Business webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For general information related to webhooks, refer to the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tol/getting_started/implementing_webhooks"},"children":["Implementing webhooks"]}," guide."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"business-onboarding-statuses","__idx":1},"children":["Business onboarding statuses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To reflect status changes during a business onboarding, we provide the following Business events types:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Status"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Status"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Descriptions"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Descriptions"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BUSINESS.CREATED "]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The business has been successfully created and waiting for checks to be completed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BUSINESS.ACTIVATED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The business has completed all checks and can actively use the Upvest Investment API."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BUSINESS.DEACTIVATED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The business has been disabled from using the"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BUSINESS.DATA_CHANGED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Changes to the business information, like email address, is in progress."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BUSINESS.DATA_CHANGE_FAILED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The attempted change to business information has not been completed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BUSINESS.OFFBOARDING_INITIATED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The business offboarding process has started."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BUSINESS.OFFBOARDED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The business is fully offboarded."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"business-check-statuses","__idx":2},"children":["Business check statuses"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Status"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Status"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Descriptions"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Descriptions"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BUSINESS_CHECK.CREATED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["A business check has successfully been created."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BUSINESS_CHECK.PASSED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The business has successfully completed all required checks."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BUSINESS_CHECK.FAILED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The business check has failed."]}]}]}]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Example response","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"/_partials/schemas/businesses/company/webhook_event_business.v1.example.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n  \"id\": \"2df83681-6a42-4837-a554-a8197335bcfa\",\n  \"created_at\": \"2021-11-22T09:04:42Z\",\n  \"type\": \"BUSINESS.CREATED\",\n  \"object\": {\n    \"id\": \"a9a72268-4f3c-4de2-abb9-a553a3bb7608\",\n    \"created_at\": \"2024-10-24T14:14:22Z\",\n    \"updated_at\": \"2024-10-24T14:14:22Z\",\n    \"contact_email\": \"acme.corporation@example.com\",\n    \"registered_address\": {\n      \"address_line1\": \"110\",\n      \"address_line2\": \"Schonhauser Allee\",\n      \"postcode\": \"101110\",\n      \"city\": \"Berlin\",\n      \"state\": \"BE\",\n      \"country\": \"DE\"\n    },\n    \"registration_number\": \"111221111\",\n    \"tax_information\": {\n      \"tax_country_code\": \"DE\",\n      \"tax_identification_type\": \"STEUERNUMMER\",\n      \"tax_identification_number\": \"111213123123\",\n      \"is_resident_in_multiple_tax_jurisdictions\": false,\n      \"is_subject_to_fatca\": false\n    },\n    \"business_type\": \"LIMITED_LIABILITY_COMPANY\",\n    \"identification\": {\n      \"company_name\": \"Acme Corporation\",\n      \"incorporation_date\": \"2000-10-10\",\n      \"district_court\": \"Berlin Charlottenburg\",\n      \"legal_designation\": \"GESELLSCHAFT_MIT_BESCHRAENKTER_HAFTUNG\",\n      \"legal_entity_identifier\": \"1234567890\",\n      \"common_reporting_standards\": {\n        \"is_passive_non_financial_entity\": false,\n        \"is_financial_institution\": false\n      }\n    },\n    \"terms_and_conditions\": {\n      \"consent_document_id\": \"6a163d14-5b3d-48be-ac90-43314e96be71\",\n      \"confirmed_at\": \"2024-10-24T14:14:22Z\"\n    },\n    \"data_privacy_and_sharing_agreement\": {\n      \"consent_document_id\": \"fa2227c3-2b29-47e1-84da-996d09517edc\",\n      \"confirmed_at\": \"2024-10-24T14:16:22Z\"\n    },\n    \"status\": \"ACTIVE\"\n  },\n  \"webhook_id\": \"1b097e06-8a14-4181-b72a-de0972a3c57b\"\n}"},"children":[]}]}]}]},"headings":[{"value":"Business webhooks","id":"business-webhooks","depth":1},{"value":"Business onboarding statuses","id":"business-onboarding-statuses","depth":2},{"value":"Business check statuses","id":"business-check-statuses","depth":2}],"frontmatter":{"seo":{"title":"Business webhooks"}},"lastModified":"2026-04-20T13:58:31.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/tol/guides/accounts/businesses_webhooks","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}