Sign in
Organization

Create organization

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 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 nameDescriptionIs demo
Empty Organization TemplateEmpty organization, suitable for further customizationno
CZ Demo TemplateCzech standard invoicesyes
Tax Invoice EU Demo TemplateVAT Invoices, Credit Notes, Debit Notes, Purchase/Sales Orders, Receipts, and Pro Formas coming from the EUyes
Tax Invoice US Demo TemplateTax Invoices, Credit Notes, Debit Notes, Purchase/Sales Orders, Receipts, and Pro Formas coming from the USyes
Tax Invoice UK Demo TemplateVAT Invoices, Credit Notes, Debit Notes, Purchase/Sales Orders, Receipts, and Pro Formas coming from the UK, India, Canada, or Australiayes
Delivery Note Demo TemplateDelivery Notesyes
Tax Invoice CN Demo Templategovernmental Tax Invoices from Mainland China (fapiaos)yes
Certificates of Analysis Demo TemplateCertificates of Analysis that are quality control documents common in the food and beverage industryyes
post/api/v1/organizations/create

Request body

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_namestring required

Name of the organization. Will be also used as a base for inbox e-mail address.

user_fullnamestring required

Full user name.

user_emailstring email required

Valid email of the user (also used as Rossum login).

user_passwordstring

Initial user password. If not provided, password will be generated.

user_ui_settingsobject

Initial UI settings.

create_keystring required

A key that allows to create an organization.

Example request

{
  "template_name": "Tax Invoice UK Demo Template",
  "organization_name": "East West Trading Co",
  "user_fullname": "John Doe",
  "user_email": "john@east-west-trading.com",
  "user_password": "owo1aiG9ua9Aihai",
  "user_ui_settings": {
    "locale": "en"
  },
  "create_key": "13156106d6f185df24648ac7ff20f64f1c5c06c144927be217189e26f8262c4a"
}

Response

Created

keystring required

Authentication token for the newly created user.

domainstring required

Domain of the newly created organization.

codestring required

One-time login token for the newly created user.

Example response

{
  "organization": {
    "id": 406,
    "name": "East West Trading Co",
    "url": "https://example.rossum.app/api/v1/organizations/406",
    "workspaces": [
      "https://example.rossum.app/api/v1/workspaces/7540"
    ],
    "users": [
      "https://example.rossum.app/api/v1/users/10775"
    ],
    "organization_group": "https://example.rossum.app/api/v1/organization_groups/17",
    "ui_settings": {},
    "metadata": {
      "some_key": "some_value"
    },
    "is_trial": true,
    "created_at": "2019-09-02T14:28:11.000000Z",
    "trial_expires_at": "2020-09-02T14:28:11.000000Z",
    "internal_info": {
      "cs_account_classification": null,
      "customer_type": null,
      "market_category": null,
      "overdue_payment_date": null,
      "sso_active": false
    },
    "creator": "https://example.rossum.app/api/v1/users/10775",
    "modified_by": "https://example.rossum.app/api/v1/users/10775",
    "modified_at": "2021-04-26T10:08:03.856648Z",
    "settings": {}
  },
  "key": "e7c4ddd996d8e92bdf780b9f0dfe8e4cd17f0c6e",
  "domain": "example.rossum.app",
  "code": "abc123def456"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.