Add user
How you add a user depends on your program type.Consumer programs
You don’t create consumer users separately. Submitting a consumer application creates the user and starts their identity check in one step. See Submit an application.Corporate programs
After Rain approves a company’s application, add its employees with Create a user in a company. OnlyfirstName and email are required.
A few things to know:
- The company must be approved first. Creating a user for a company that isn’t approved returns
403. - Each new user gets a short identity check. The response includes the user’s
applicationStatus, and anapplicationCompletionLinkif they need to finish verification. Track status changes with theuser.updatedwebhook. - Limits. Each company can have up to 100 approved users by default; contact your Implementation Manager to raise it. During production testing, your whole tenant is limited to 10 approved users.
Deactivate user
You can set users as active or inactive. You can update the user with the desired value in theisActive parameter. This will change their status, and you will see the change when you fetch users through the API.
Delete user
Submit theuserId to the delete user endpoint to delete their information. This will also set the status of all cards of that user to cancelled. You will receive a card.updated webhook for each card that is cancelled, with a statusChangeReason of user_deleted.