# Create a business Creates a business. Endpoint: POST /businesses Version: 1.111.0 Security: oauth-client-credentials ## Header parameters: - `upvest-client-id` (string, required) Tenant Client ID Example: "363f3305-7ab0-4e82-a158-f9d382ad08b6" - `Authorization` (string, required) Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750 Example: "Bearer c2VjcmV0Cg==" - `signature` (string, required) https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header - `signature-input` (string, required) https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he - `idempotency-key` (string, required) A UUID to be used as an idempotency key. This prevents a duplicate request from being replayed. https://docs.upvest.co/documentation/concepts/api_concepts/idempotency Example: "ccb07f42-4104-44ad-8e1f-c660bb7b269c" - `upvest-api-version` (string) Upvest API version (Note: Do not include quotation marks) Enum: "1" ## Request fields (application/json): - `body` (object) - `contact_email` (string, required) Contact email address of the business. - `registered_address` (object, required) Address. Must not be a P.O. box or c/o address. - `registered_address.address_line1` (string, required) First address line of the address. - `registered_address.postcode` (string, required) Postal code (postcode, PIN or ZIP code) - `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" - `registered_address.city` (string, required) - `registered_address.address_line2` (string) Second address line of the address. - `registered_address.state` (string) State, province, county. [ISO 3166 alpha-2 Codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - `registration_number` (string, required) Registration number of the business. - `business_type` (any, required) Type of the business. - `tax_information` (object, required) Tax information of the business. - `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: same as `registered_address.country` (250 values) - `tax_information.tax_identification_type` (string, required) Type of tax identification used by the business. Enum: "STEUERNUMMER", "WIRTSCHAFTSIDENTIFIKATIONSNUMMER" - `tax_information.tax_identification_number` (string, required) Tax identification number of the business. - `tax_information.is_resident_in_multiple_tax_jurisdictions` (boolean, required) Indicates if the business is resident in multiple tax jurisdictions. - `tax_information.is_subject_to_fatca` (boolean, required) Indicates if the business is subject to FATCA regulations. - `identification` (object, required) Identification information of the business. - `identification.company_name` (string, required) Name of the company. - `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) - `identification.district_court` (string, required) District court where the company is registered. - `identification.legal_designation` (string, required) Country specific legal designation of the company. Note: AKTIENGESELLSCHAFT businesses cannot be created via the API; please contact Upvest support before onboarding such a business. Enum: "GESELLSCHAFT_MIT_BESCHRAENKTER_HAFTUNG", "UNTERNEHMERGESELLSCHAFT", "AKTIENGESELLSCHAFT" - `identification.common_reporting_standards` (object, required) Common reporting standards information. - `identification.common_reporting_standards.is_passive_non_financial_entity` (boolean, required) Indicates if the company is a passive non-financial entity. - `identification.common_reporting_standards.is_financial_institution` (boolean, required) Indicates if the company is a financial institution. - `identification.legal_entity_identifier` (string) Legal Entity Identifier (LEI) of the company. - `terms_and_conditions` (object, required) Terms and conditions agreement. - `terms_and_conditions.consent_document_id` (string, required) UUID of the consent document. - `terms_and_conditions.confirmed_at` (string, required) Timestamp when the terms and conditions were confirmed. - `data_privacy_and_sharing_agreement` (object, required) Data privacy and sharing agreement. - `data_privacy_and_sharing_agreement.consent_document_id` (string, required) UUID of the data privacy and sharing agreement document. - `data_privacy_and_sharing_agreement.confirmed_at` (string, required) Timestamp when the data privacy and sharing agreement was confirmed. ## Response 200 fields (application/json): - `body` (object) - `id` (string) Unique identifier for the business. - `created_at` (string) 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) - `updated_at` (string) 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) - `contact_email` (string) Contact email address of the business. - `registered_address` (object) Address. Must not be a P.O. box or c/o address. - `registered_address.address_line1` (string, required) First address line of the address. - `registered_address.postcode` (string, required) Postal code (postcode, PIN or ZIP code) - `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: same as `registered_address.country` (250 values) - `registered_address.city` (string, required) - `registered_address.address_line2` (string) Second address line of the address. - `registered_address.state` (string) State, province, county. [ISO 3166 alpha-2 Codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - `registration_number` (string) Registration number of the business. - `tax_information` (object) Tax information of the business. - `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: same as `registered_address.country` (250 values) - `tax_information.tax_identification_type` (string, required) Type of tax identification used by the business. Enum: same as `tax_information.tax_identification_type` (2 values) - `tax_information.tax_identification_number` (string, required) Tax identification number of the business. - `tax_information.is_resident_in_multiple_tax_jurisdictions` (boolean, required) Indicates if the business is resident in multiple tax jurisdictions. - `tax_information.is_subject_to_fatca` (boolean, required) Indicates if the business is subject to FATCA regulations. - `business_type` (any) Type of the business. - `identification` (object) Identification information of the business. - `identification.company_name` (string, required) Name of the company. - `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) - `identification.district_court` (string, required) District court where the company is registered. - `identification.legal_designation` (string, required) Country specific legal designation of the company. Note: AKTIENGESELLSCHAFT businesses cannot be created via the API; please contact Upvest support before onboarding such a business. Enum: same as `identification.legal_designation` (3 values) - `identification.common_reporting_standards` (object, required) Common reporting standards information. - `identification.common_reporting_standards.is_passive_non_financial_entity` (boolean, required) Indicates if the company is a passive non-financial entity. - `identification.common_reporting_standards.is_financial_institution` (boolean, required) Indicates if the company is a financial institution. - `identification.legal_entity_identifier` (string) Legal Entity Identifier (LEI) of the company. - `terms_and_conditions` (object) Terms and conditions agreement. - `terms_and_conditions.consent_document_id` (string, required) UUID of the consent document. - `terms_and_conditions.confirmed_at` (string, required) Timestamp when the terms and conditions were confirmed. - `data_privacy_and_sharing_agreement` (object) Data privacy and sharing agreement. - `data_privacy_and_sharing_agreement.consent_document_id` (string, required) UUID of the data privacy and sharing agreement document. - `data_privacy_and_sharing_agreement.confirmed_at` (string, required) Timestamp when the data privacy and sharing agreement was confirmed. - `status` (any) Status of the business. * ACTIVE - * INACTIVE - * OFFBOARDING - * OFFBOARDED - Enum: "ACTIVE", "INACTIVE", "OFFBOARDING", "OFFBOARDED" ## Response 400 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, required) Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers. - `title` (string) A short, human-readable title for the general error type; the title should not change for given types. - `detail` (string) A human-readable description of the specific error. - `instance` (string) This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response. - `request_id` (string) Correlation ID for the original request. ## Response 401 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, required) Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers. - `title` (string) A short, human-readable title for the general error type; the title should not change for given types. - `detail` (string) A human-readable description of the specific error. - `instance` (string) This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response. - `request_id` (string) Correlation ID for the original request. ## Response 403 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, required) Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers. - `title` (string) A short, human-readable title for the general error type; the title should not change for given types. - `detail` (string) A human-readable description of the specific error. - `instance` (string) This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response. - `request_id` (string) Correlation ID for the original request. ## Response 406 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, required) Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers. - `title` (string) A short, human-readable title for the general error type; the title should not change for given types. - `detail` (string) A human-readable description of the specific error. - `instance` (string) This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response. - `request_id` (string) Correlation ID for the original request. ## Response 429 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, required) Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers. - `title` (string) A short, human-readable title for the general error type; the title should not change for given types. - `detail` (string) A human-readable description of the specific error. - `instance` (string) This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response. - `request_id` (string) Correlation ID for the original request. ## Response 500 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, required) Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers. - `title` (string) A short, human-readable title for the general error type; the title should not change for given types. - `detail` (string) A human-readable description of the specific error. - `instance` (string) This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response. - `request_id` (string) Correlation ID for the original request. ## Response 503 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, required) Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers. - `title` (string) A short, human-readable title for the general error type; the title should not change for given types. - `detail` (string) A human-readable description of the specific error. - `instance` (string) This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response. - `request_id` (string) Correlation ID for the original request. ## Response 504 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, required) Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers. - `title` (string) A short, human-readable title for the general error type; the title should not change for given types. - `detail` (string) A human-readable description of the specific error. - `instance` (string) This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response. - `request_id` (string) Correlation ID for the original request.