{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Creating a user","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"creating-a-user","__idx":0},"children":["Creating a user"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The steps below explain how to create a new user."]},{"$$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":{"data-label":"Step"},"children":["Step"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"width":"20%","data-label":"Endpoint"},"children":["Endpoint "]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Details"},"children":["Details"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/companyapi/companies/listcompanies"},"children":["List companies"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/companies/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List all the companies that are part of the TMC. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","Use this endpoint to find the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["companyId"]}," of the company for which a new user needs to be created. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body requires:"]}," The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["companyRole"]}," must be set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ORG"]},". ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response will contain:"]}," An ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["elements"]}," array containing company objects."," ","Each element includes an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," (company ID) and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," (company name)."," ","Also includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["length"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["totalNumResults"]}," fields.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sample Response:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"length\": 1,\n  \"elements\": [\n    {\n      \"id\": \"abc5b835-8001-430c-98f8-abcedefba4cf\",\n      \"name\": \"Spotnana Technology Ltd.\"\n    }\n  ],\n\"totalNumResults\": 1\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ol","attributes":{"start":2},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/companyapi/legal-entities/listlegalentities"},"children":["List legal entities"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/companies/{companyId}/legal-entities"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List all legal entities that are part of a company. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL path requires:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["companyId"]}," from step 1. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response will contain:"]}," The list of all legal entity ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ids"]}," along with their ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["names"]},". ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Other APIs will use:"]}," The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," of the legal entity under which the user needs to be created."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ol","attributes":{"start":3},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/usersapi/users/createuser"},"children":["Create user"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/users/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a new user profile on the Spotnana platform. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body requires:"]}," The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["persona"]}," of the user, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["businessInfo"]}," > ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["legalEntityRef"]}," > ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," from step 2, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["organizationRef"]}," > ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," from step 1. These are the only mandatory fields that must be populated when creating a new user. All the other fields in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/users/"]}," API are optional and can be updated later using the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/usersapi/users/updateuser"},"children":["update user"]}," endpoint. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["companyId"]}," retrieved from step 1 can be used as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["orgId"]}," in this endpoint. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response will contain:"]}," The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userId"]}," of the user. You can use this identifier to update other user details via the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/openapi/usersapi/users/updateuser"},"children":["update user"]}," API."]}]}]}]}]}]},"headings":[{"value":"Creating a user","id":"creating-a-user","depth":1}],"frontmatter":{"seo":{"title":"Creating a user"}},"lastModified":"2026-02-25T08:57:52.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/spotnana/user_creation_workflow","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}