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.
Every KYC Protect endpoint accepts the optional X-Team-Id request header. Send a team id from List Teams to work in that team.
- If you leave the header out, the request works in the default team.
- Records created in a team can only be seen by sending that team's id. For example, a profile created with
X-Team-Iddoesn't appear in a request without the header. - A team id that doesn't exist, or a team that is being deleted, is rejected with
404 Team Not Found.
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.
Each teams endpoint that changes data needs a permission, granted through the user's role. See RBAC APIs Overview for how roles and permissions are managed.
| Endpoint | Required permission |
|---|---|
| Create A Team | Configure Teams |
| Update A Team | Configure Teams |
| Delete A Team | Delete Teams |
| Add Users To A Team | Assign Role To Users |
- The user who creates a team is added to it with the Admin role.
- Team names must be unique in the account. The check ignores case, so
Complianceandcompliancecount as the same name. A name that is already in use is rejected with409. - A name can be up to 150 characters and can't be blank. A description can be up to 250 characters.
- There's no limit on the number of teams in an account, or on the number of users in a team.
- 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
200, and each one is listed infailedwith the reason, for example an unknown user or role, or a user who is already in the team. - Removing users: users that can't be removed don't fail the request: it returns
201, and each one is listed infailedwith the reason. Users can't remove themselves from a team. - 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.
When you delete a team, choose what happens to its records with actionOnRecords:
move: the team's records are moved to the default team.delete: the team's records are deleted.
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 isDeletionInProgress set to true until processing finishes, which can take several minutes or longer. With move, the records appear in the default team once processing finishes.
List Teams and List Team Users return results one page at a time. Both page and pageSize must be sent, and pageSize can be between 1 and 100. A request without either is rejected with 400.