--- title: "Create organization" method: POST path: "/api/v1/organizations/create" tags: ["Organization"] --- # Create organization `POST /api/v1/organizations/create` Create new organization and related objects (workspace, queue, user, schema, inbox, domain). You need a `create_key` in order to create an organization. Please contact [support@rossum.ai](mailto:support@rossum.ai) to obtain one. Selected `template_name` affects default schema and extracted fields. Please note that the demo templates may be updated as new features are introduced. List of available templates: | Template name | Description | Is demo | |-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|---------| | Empty Organization Template | Empty organization, suitable for further customization | no | | CZ Demo Template | Czech standard invoices | yes | | Tax Invoice EU Demo Template | VAT Invoices, Credit Notes, Debit Notes, Purchase/Sales Orders, Receipts, and Pro Formas coming from the EU | yes | | Tax Invoice US Demo Template | Tax Invoices, Credit Notes, Debit Notes, Purchase/Sales Orders, Receipts, and Pro Formas coming from the US | yes | | Tax Invoice UK Demo Template | VAT Invoices, Credit Notes, Debit Notes, Purchase/Sales Orders, Receipts, and Pro Formas coming from the UK, India, Canada, or Australia | yes | | Delivery Note Demo Template | Delivery Notes | yes | | Tax Invoice CN Demo Template | governmental Tax Invoices from Mainland China (fapiaos) | yes | | Certificates of Analysis Demo Template | Certificates of Analysis that are quality control documents common in the food and beverage industry | yes | ## Request body - OrganizationsCreate - `template_name` 'Empty Organization Template' | 'CZ Demo Template' | 'Tax Invoice EU Demo Template' | 'Tax Invoice US Demo Template' | 'Tax Invoice UK Demo Template' | 'Delivery Note Demo Template' | 'Tax Invoice CN Demo Template' | 'Certificates of Analysis Demo Template', required — Template to use for new organization. - `organization_name` string, required — Name of the organization. Will be also used as a base for inbox e-mail address. - `user_fullname` string, required — Full user name. - `user_email` string, email, required — Valid email of the user (also used as Rossum login). - `user_password` string — Initial user password. If not provided, password will be generated. - `user_ui_settings` object — Initial UI settings. - `create_key` string, required — A key that allows to create an organization. ## Response `201` Created - object - `organization` Organization, required - `id` integer, required — ID of the organization. - `name` string, required — Name of the organization (not visible in UI). - `url` string, uri, required — URL of the organization. - `workspaces` string[], required — List of workspaces objects in the organization. - `users` string[], required — List of users in the organization. - `organization_group` string, uri, required — URL to organization group the organization belongs to. - `ui_settings` object, required — Organization-wide frontend UI settings (e.g. locales). Rossum internal. - `metadata` Metadata, required — Client data. May be used to store e.g. external system object IDs. See [Metadata](/guides/overview#metadata) for more details. - `is_trial` boolean, required — Property indicates whether this license is a trial license. - `created_at` string, date-time, required — Timestamp for when the organization was created. - `trial_expires_at` string, date-time, nullable — Timestamp for when the trial period ended (ISO 8601). - `oidc_provider` string, nullable — (Deprecated) OpenID Connect provider name. - `internal_info` object, nullable — **INTERNAL** Rossum internal information on organization. - `cs_account_classification` string, nullable — Account classification in SalesForce. - `customer_type` string, nullable — Customer type in SalesForce. - `market_category` string, nullable — Customer market category in SalesForce. - `overdue_payment_date` string, date-time, nullable — Date of overdue payment. If empty, no payment is overdue. There may be a delay between update of the value of this field and the actual payment settlement with the Finance team and/or other customer-facing teams. - `sso_active` boolean, nullable — Customer has SSO login enabled. - `creator` string, uri, nullable — URL of the first user of the organization (set during organization creation). - `modified_by` string, uri, nullable, required — User that last modified the object. - `modified_at` string, date-time, nullable, required — Timestamp of last modification. - `settings` object, required — Settings of the organization. - `annotation_list_table` object — Configuration of annotation dashboard columns. - `columns` AnnotationListTable[] — Configuration of columns on annotation list. - `visible` boolean — Column is visible on the dashboard. - `width` number, float — Width of the column. - `column_type` 'meta' | 'schema' — Type of the field (`meta` - annotation meta field, `schema` - annotation content field). - `schema_id` string — `schema_id` of the extracted field (only for `column_type=schema`). - `data_type` 'date' | 'number' | 'string' | 'boolean' — Data type of the extracted field (only for `column_type=schema`). Allowed values are `date`, `number`, `string`, `boolean`. - `meta_type` string — Meta column type (only for `column_type=meta`). Allowed values can be found in `meta_field` table (+ additionally `details`). - `request_dashboard_table` object — Configuration of request dashboard columns. - `columns` AnnotationListTable[] — Configuration of columns on request dashboard. - `visible` boolean — Column is visible on the dashboard. - `width` number, float — Width of the column. - `column_type` 'meta' | 'schema' — Type of the field (`meta` - annotation meta field, `schema` - annotation content field). - `schema_id` string — `schema_id` of the extracted field (only for `column_type=schema`). - `data_type` 'date' | 'number' | 'string' | 'boolean' — Data type of the extracted field (only for `column_type=schema`). Allowed values are `date`, `number`, `string`, `boolean`. - `meta_type` string — Meta column type (only for `column_type=meta`). Allowed values can be found in `meta_field` table (+ additionally `details`). - `sandbox` boolean, required — Specifies if the organization is a sandbox. - `key` string, required — Authentication token for the newly created user. - `domain` string, required — Domain of the newly created organization. - `code` string, required — One-time login token for the newly created user. ## Other responses - `400` — Invalid input data. - `401` — The username/password is invalid or token is invalid (e.g. expired). - `403` — Insufficient permission, missing authentication, invalid CSRF token and similar issue. - `404` — The specified resource was not found. - `409` — Conflict - `413` — Payload too large (especially for files uploaded). - `429` — Request rate is too high, wait before sending more requests. See [Rate Limiting](/guides/overview#rate-limiting) for more details. - `500` — Server failure while processing the request. - `502` — Invalid response from the upstream server. - `503` — We're temporarily offline for maintenance. Please try again later. - `504` — Upstream server could not complete the request in time. --- [API](https://skmtc.dev/rossum/apis/rossum-api.md) · [All operations](https://skmtc.dev/rossum/apis/rossum-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rossum/rossum-api/revisions/f1b5a910991d/schema)