Create workspace
POST {{baseUrl}}/{{version}}/workspace
Here you can create a brand new Workspace.
Note: Only Organization credentials are able to create Workspaces.
username | REQUIRED | This string uniquely identifies the Workspace in our entire database. It is also part of the Workspace Web Banking URL and must, therefore, be URL-safe. For example, if a Workspace in Sandbox has the my-workspaceusername, its URL would be https://my-workspace.sandbox.starkbank.com |
name | REQUIRED | This string will show up to identify your Workspace when you log into it at our Web Banking. Example: My Workspace |
allowedTaxIds | OPTIONAL | List of tax IDs that will be allowed to send Deposits to this Workspace. If empty, all are allowed. Example: [012.345.678-90, 20.018.183/0001-80] |
Request Body
{"username"=>"new-workspace", "name"=>"New Workspace", "allowedTaxIds"=>["868.129.489-00", "27.448.965/0001-06"]}