{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-connect-apis-catalog/product-catalog/KYCProtect/sidebars.yaml","current-catalog-info":"current-catalog-info-/connect-apis-catalog/product-catalog/kycprotect/kycprotect"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Teams","llmstxt":{"hide":true}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"teams","__idx":0},"children":["Teams"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Teams group users and the records they work on in KYC Protect, such as profiles, searches and monitoring. Every account has a default team. You can create more teams, add users to them with a role, and choose which team each request works in."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/kycprotect/teams/compliancekycprotectauthorizationteamsget"},"children":["View the Teams endpoints"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"working-in-a-team-the-x-team-id-header","__idx":1},"children":["Working in a team: the X-Team-Id header"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every KYC Protect endpoint accepts the optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Team-Id"]}," request header. Send a team ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," from List Teams to work in that team."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If you leave the header out, the request works in the default team."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Records created in a team can only be seen by sending that team's id. For example, a profile created with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Team-Id"]}," doesn't appear in a request without the header."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A team id that doesn't exist, or a team that is being deleted, is rejected with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Team Not Found"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"who-can-see-which-teams","__idx":2},"children":["Who can see which teams"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List Teams returns only the teams the current user belongs to. This applies to every role, including administrators: a user doesn't see a team they aren't a member of."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"permissions","__idx":3},"children":["Permissions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each teams endpoint that changes data needs a permission, granted through the user's role. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://doc.creditsafe.com/connect-apis-catalog/product-catalog/kycprotect/documentation/additionalinformation/rolebasedaccesscontrol"},"children":["RBAC APIs Overview"]}," for how roles and permissions are managed."]},{"$$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":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required permission"},"children":["Required permission"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create A Team"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure Teams"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update A Team"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure Teams"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete A Team"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete Teams"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Add Users To A Team"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Assign Role To Users"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"creating-and-updating-a-team","__idx":4},"children":["Creating and updating a team"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The user who creates a team is added to it with the Admin role."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Team names must be unique in the account. The check ignores case, so ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Compliance"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["compliance"]}," count as the same name. A name that is already in use is rejected with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["409"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A name can be up to 150 characters and can't be blank. A description can be up to 250 characters."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["There's no limit on the number of teams in an account, or on the number of users in a team."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"team-members","__idx":5},"children":["Team members"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Adding users:"]}," each user is added with a role in that team. Users that can't be added don't fail the request: it returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]},", and each one is listed in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failed"]}," with the reason, for example an unknown user or role, or a user who is already in the team."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Removing users:"]}," users that can't be removed don't fail the request: it returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["201"]},", and each one is listed in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failed"]}," with the reason. Users can't remove themselves from a team."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["At least one Admin:"]}," a team must always keep at least one user with the Admin role, so the last Admin in a team can't be removed."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"deleting-a-team","__idx":6},"children":["Deleting a team"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you delete a team, choose what happens to its records with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["actionOnRecords"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["move"]},": the team's records are moved to the default team."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["delete"]},": the team's records are deleted."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The deletion runs in the background. The team can't be used as soon as the request succeeds, but it stays in List Teams with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isDeletionInProgress"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," until processing finishes, which can take several minutes or longer. With ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["move"]},", the records appear in the default team once processing finishes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"paging","__idx":7},"children":["Paging"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List Teams and List Team Users return results one page at a time. Both ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}," must be sent, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}," can be between 1 and 100. A request without either is rejected with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},"."]}]},"headings":[{"value":"Teams","id":"teams","depth":1},{"value":"Working in a team: the X-Team-Id header","id":"working-in-a-team-the-x-team-id-header","depth":2},{"value":"Who can see which teams","id":"who-can-see-which-teams","depth":2},{"value":"Permissions","id":"permissions","depth":2},{"value":"Creating and updating a team","id":"creating-and-updating-a-team","depth":2},{"value":"Team members","id":"team-members","depth":2},{"value":"Deleting a team","id":"deleting-a-team","depth":2},{"value":"Paging","id":"paging","depth":2}],"frontmatter":{"title":"Teams","description":"How teams work in KYC Protect, covering the X-Team-Id header, who can see which teams, the permissions each teams endpoint needs, team membership rules and deleting a team.","audience":"customer","product":"KYC Protect","topic":"Teams","keywords":["teams","X-Team-Id","RBAC","roles","permissions","team membership"],"seo":{"title":"Teams"}},"lastModified":"2026-11-04T14:47:38.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/connect-apis-catalog/product-catalog/kycprotect/documentation/additionalinformation/teams","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}