{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["img","tabs","tab","code-snippet"]},"type":"markdown"},"seo":{"title":"Onboard a sole trader","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"}]},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"onboard-a-sole-trader","__idx":0},"children":["Onboard a sole trader"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authentication scopes"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accounts:admin"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["businesses:admin"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["checks:admin"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["roles:admin"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["users:admin"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taxes:admin"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information, refer to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/byol/concepts/api_concepts/authentication/authentication_oauth#list-of-authentication-scopes"},"children":["Authentication scopes"]},"."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":2},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This section explains how to create a business account for sole traders. For information on business accounts for larger businesses and corporations, refer to the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/byol/guides/accounts/businesses_implementing_corporate"},"children":["Create a corporate business account"]}," section."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/onboard_sole_trader_flow_diagram_byol.5ecda6ce195c952dd94a9fc804d738dbcf7bdcd077e0ab1d669d19bdd1b0bc04.dae188b9.png","framed":false,"withLightbox":true},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-create-the-sole-trader-entity","__idx":3},"children":["Step 1: Create the sole trader entity"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Clients must use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/businesses"]}," endpoint to create a new sole trader entity in addition to the user entity.  This additionally includes all tax and identity information related to the individual’s incorporation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST /businesses"]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Example request","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"/_partials/schemas/businesses/sole_trader/create_business_request.v1.example.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\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\": \"12345678901\",\n        \"is_resident_in_multiple_tax_jurisdictions\": false,\n        \"is_subject_to_fatca\": false\n    },\n    \"business_type\": \"SOLE_TRADER\",\n    \"identification\": {\n        \"company_name\": \"Max Mustermann - Web Design\",\n        \"incorporation_date\": \"2000-10-10\",\n        \"legal_designation\": \"EINZELUNTERNEHMER\"\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}"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Example response","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"/_partials/schemas/businesses/sole_trader/create_business_response.v1.example.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\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\": \"12345678901\",\n        \"is_resident_in_multiple_tax_jurisdictions\": false,\n        \"is_subject_to_fatca\": false\n    },\n    \"business_type\": \"SOLE_TRADER\",\n    \"identification\": {\n        \"company_name\": \"Max Mustermann - Web Design\",\n        \"incorporation_date\": \"2000-10-10\",\n        \"legal_designation\": \"EINZELUNTERNEHMER\"\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}"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The table below shows the related parameters and their descriptions."]},{"$$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":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Required"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$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":["contact_email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Contact email address of the sole trader."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["registered_address"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The official, registered address of the sole trader."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["registration_number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Optional"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The registration number of the sole trader as listed in the commercial registry."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tax_information"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".tax_country_code"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Optional"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Accepted country code as listed in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"},"children":["ISO 3166-1 alpha-2 code"]},". For Germany, this value equals \"DE\"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tax_information"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".tax_identification_number"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Optional"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Tax identification number of the business. For Germany, this equals the USt-ID / Umsatzsteuer-ID."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tax_information"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".is_resident_in_multiple_tax_jurisdictions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Optional"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Indicates if the sole trader is resident in multiple tax jurisdictions. At this time, business accounts are only available for entities resident in a single tax jurisdiction."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tax_information"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".is_subject_to_fatca"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Optional"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Indicates if the sole trader is subject to FATCA regulations. At this time, business accounts are only available for entities that are not subject to FATCA regulations."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["business_type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The official, registered type of business. Currently we support the following: ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"- ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SOLE_TRADER"]},": In Germany, this applies to ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Einzelunternehmen"]},". ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"- ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LIMITED_LIABILITY_COMPANY"]},": In Germany, this applies to the following:  Gesellschaft mit beschränkter Haftung (GmbH)  Unternehmergesellschaft (UG). Aktiengesellschaft (AG). ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"For instructions to onboard corporate corporate entities, refer to the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/byol/guides/accounts/businesses_implementing_corporate"},"children":["Creating corporate business accounts"]}," section."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data_privacy_and_sharing_agreement"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".consent_document_id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Optional"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The universally unique identifier (UUID) of the data privacy and sharing agreement document."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data_privacy_and_sharing_agreement"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".confirmed_at"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Optional"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The timestamp when the data privacy and sharing agreement was confirmed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["terms_and_conditions"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".consent_document_id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Optional"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The universally unique identifier (UUID) of the consent document."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["terms_and_conditions"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".confirmed_at"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Optional"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Timestamp when the terms and conditions were confirmed."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sole-trader-lifecycle-status","__idx":4},"children":["Sole Trader lifecycle status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The process for creating a business entity for a sole trader and its lifecycle goes through the following 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":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["INACTIVE"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The sole trader’s approval is pending. The sole trader entity is visible via our API but cannot be processed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["ACTIVE"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The sole trader is active and able to use the full functionality of the Investment API"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["OFFBOARDING"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The offboarding process has started. The sole trader remains in this status until there are no open account groups and no pending regulatory reporting (e.g., annual tax statements)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["OFFBOARDED"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The sole trader is offboarded. The sole trader’s record can be kept for the regulatory period."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can listen to the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/businesses/business_event"},"children":["Business events webhook"]}," for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BUSINESS.CREATED"]}," message which provides confirmation that the business was successfully created."]},{"$$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/sole_trader/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\": \"12345678901\",\n        \"is_resident_in_multiple_tax_jurisdictions\": false,\n        \"is_subject_to_fatca\": false\n    },\n    \"business_type\": \"SOLE_TRADER\",\n    \"identification\": {\n        \"company_name\": \"Max Mustermann - Web Design\",\n        \"incorporation_date\": \"2000-10-10\",\n        \"legal_designation\": \"EINZELUNTERNEHMER\"\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":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-create-a-business-account-group-and-account","__idx":5},"children":["Step 2: Create a business account group and account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To create the business ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/byol/guides/accounts/accounts_create_account_groups"},"children":["account group"]},", simply set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: \"BUSINESS\""]}," when creating the account group."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST"]}," /account_groups"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Example request","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"/_partials/schemas/accounts/business/create_account_group_request.v1.example.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n  \"business_id\": \"bc6f8c82-1234-4b56-a7d8-9e012345f678\",\n  \"type\": \"BUSINESS\",\n  \"securities_account_number\": \"12345689\"\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Example response","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"/_partials/schemas/accounts/business/create_account_group_response.v1.example.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n  \"id\": \"9d95820d-4333-46b6-98de-04ab7512e76f\",\n  \"created_at\": \"2020-08-24T14:15:22Z\",\n  \"updated_at\": \"2020-08-24T14:15:22Z\",\n  \"type\": \"BUSINESS\",\n  \"status\": \"ACTIVE\",\n  \"business_id\": \"bc6f8c82-1234-4b56-a7d8-9e012345f678\",\n  \"securities_account_number\": \"123456789\"\n}\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once completed, you can create a new account for the sole trader using the /accounts endpoint."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/accounts/create_account"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST /accounts"]}]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Example request","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"/_partials/schemas/accounts/business/create_account_request.v1.example.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n  \"business_id\": \"bc6f8c82-1234-4b56-a7d8-9e012345f678\",\n  \"account_group_id\": \"fa2414ed-8d62-46fd-85ed-565a340c81d6\",\n  \"type\": \"TRADING\",\n  \"name\": \"Main account\"\n}\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-create-the-user-associated-with-the-sole-trader","__idx":6},"children":["Step 3: Create the user associated with the sole trader"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creating related users for sole trader business accounts is similar to creating an individual user. For more information on creating a user, refer to our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/byol/guides/users"},"children":["Users guide"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST /users"]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Example request","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"/_partials/schemas/users/tol/create_user_request.v1.example-without-consents.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n  \"first_name\": \"Karl\",\n  \"last_name\": \"Schmidt\",\n  \"email\": \"karl.schmidt@example.com\",\n  \"salutation\": \"SALUTATION_MALE\",\n  \"title\": \"DR\",\n  \"birth_date\": \"1972-09-30\",\n  \"birth_city\": \"Berlin\",\n  \"birth_country\": \"DE\",\n  \"birth_name\": \"Schmidt\",\n  \"nationalities\": [\n    \"DE\",\n    \"AU\"\n  ],\n  \"phone_number\": \"4930901820\",\n  \"postal_address\": {\n    \"address_line1\": \"Rosenweg 221\",\n    \"address_line2\": \"apt. 33\",\n    \"postcode\": \"45678\",\n    \"city\": \"Berlin\",\n    \"state\": \"BE\",\n    \"country\": \"DE\"\n  },\n  \"address\": {\n    \"address_line1\": \"Rosenweg 221\",\n    \"address_line2\": \"apt. 33\",\n    \"postcode\": \"45678\",\n    \"city\": \"Berlin\",\n    \"state\": \"BE\",\n    \"country\": \"DE\"\n  },\n  \"fatca\": {\n    \"status\": false,\n    \"confirmed_at\": \"2020-08-24T14:15:22Z\"\n  }\n}\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-a-know-your-customer-check","__idx":7},"children":["Create a Know Your Customer check"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For sole traders, the user must complete a Know Your Customer (KYC) check."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In addition, all users for a business account are subject to the Politically Exposed Persons (PEP) checks and sanctions screening."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information on user checks, refer to our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/byol/guides/users"},"children":["Users guide"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST /users/{user_id}/checks"]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Example request","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"/_partials/schemas/users/tol/checks/kyc/create_user_check_request.v1.example-kyc.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n  \"type\": \"KYC\",\n  \"check_confirmed_at\": \"2019-08-24T14:15:22Z\",\n  \"data_download_link\": \"https://bucket.customer.com/ident/user3.zip\",\n  \"document_type\": \"ID_CARD\",\n  \"document_expiration_date\": \"2030-01-01\",\n  \"nationality\": \"DE\",\n  \"provider\": \"KYC provider\",\n  \"method\": \"VIDEO_ID\",\n  \"confirmed_address\": {\n    \"address_line1\": \"Rosenweg 221\",\n    \"address_line2\": \"apt. 33\",\n    \"postcode\": \"45678\",\n    \"city\": \"Berlin\",\n    \"state\": \"BE\",\n    \"country\": \"DE\"\n  }\n}"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-a-user-tax-residency","__idx":8},"children":["Create a user tax residency"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Upvest requires the user to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/byol/guides/users/users_tax_onboarding"},"children":["submit tax-related information"]}," as part of their onboarding process."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Example request","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"/_partials/schemas/taxes/set_tax_residencies_request.v1.example2.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n   \"tax_residencies\": [\n      {\n         \"country\": \"DE\",\n         \"tax_identifier_number\": \"12345678901\"\n      }\n   ]\n}"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-a-user-identifier","__idx":9},"children":["Create a user identifier"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If required, you must create a user identifier for the end user. Complete details on user identifiers can be found in our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/byol/guides/users/users_identifiers"},"children":["User Identifiers"]}," section."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Example request","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"/_partials/schemas/identifiers/create_identifier_request.v1.national_id.example.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"type\": \"NATIONAL_ID\",\n    \"issuing_country\": \"PL\",\n    \"identifier_standard\": \"PESEL\",\n    \"identifier\": \"83053078917\"\n}"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"sole-trader-data-change","__idx":10},"children":["Sole trader data change"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We provide the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/businesses/{business_id}/data_change_requests"]}," endpoint to allow you to update the contact email for any sole trader."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST /businesses/{business_id}/data_change_requests"]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Example request","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"/_partials/schemas/businesses/business_data_change_request.v1.example-contact_email.json","language":"json","header":{"controls":{"copy":{}}},"lang":"json","source":"{\n    \"contact_email\": \"acme.corporation@example.com\"\n}"},"children":[]}]}]}]},"headings":[{"value":"Onboard a sole trader","id":"onboard-a-sole-trader","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Overview","id":"overview","depth":2},{"value":"Step 1: Create the sole trader entity","id":"step-1-create-the-sole-trader-entity","depth":2},{"value":"Sole Trader lifecycle status","id":"sole-trader-lifecycle-status","depth":3},{"value":"Step 2: Create a business account group and account","id":"step-2-create-a-business-account-group-and-account","depth":2},{"value":"Step 3: Create the user associated with the sole trader","id":"step-3-create-the-user-associated-with-the-sole-trader","depth":2},{"value":"Create a Know Your Customer check","id":"create-a-know-your-customer-check","depth":3},{"value":"Create a user tax residency","id":"create-a-user-tax-residency","depth":3},{"value":"Create a user identifier","id":"create-a-user-identifier","depth":3},{"value":"Sole trader data change","id":"sole-trader-data-change","depth":2}],"frontmatter":{"seo":{"title":"Onboard a sole trader"}},"lastModified":"2026-07-22T10:54:17.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/byol/guides/accounts/businesses_implementing_sole_trader","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}