| routes |
Get list of available API routes |
/api/v1/users/routes |
GET |
| authenticate |
Authenticate a user using their access token (Authorization header Bearer token) credentials. Useful for external services trying to authenticate a user before giving them access to protected operations. |
/api/v1/users/auth |
POST |
| searchUsers |
Search for users by firstname, lastname, email |
/api/v1/users/search |
GET |
| resendVerificationEmail |
Re-send verification email |
/api/v1/users/resend-verification-email |
GET |
| sendNotification |
Send notification (email, text message, etc) to a user or users. |
/api/v1/users/send-notification |
POST |
| getUser |
Get details of user specified by their id |
/api/v1/users/:userId:userId |
GET |
| requestAccountDeletion |
Used by users to request that their accounts be deleted |
/api/v1/users/account-deletion/new |
GET |
| getAccountDeletionRequests |
Get listing of account deletion requests by users |
/api/v1/users/account-deletion/list |
GET |
| verifyEmail |
Verify user email after signup |
/api/v1/users/email/verify |
GET |
| listUsers |
Fetch list of registered users |
/api/v1/users/ |
GET |
| signup |
Register (create) a new user |
/api/v1/users/ |
POST |
| login |
Log user in |
/api/v1/users/login |
POST |
| logout |
Logout a signed-in user |
/api/v1/users/logout |
POST |
| forgotPassword |
Notify the app that a user has forgotten their password |
/api/v1/users/password/forgot |
POST |
| resetPassword |
Reset user password |
/api/v1/users/password/reset |
POST |
| updateUser |
Update user details |
/api/v1/users/:userId:userId |
PUT |
| editUserRole |
Edit user role |
/api/v1/users/:userId/role:userId |
PUT |
| editUserStatus |
Edit user status |
/api/v1/users/:userId/status:userId |
PUT |
| deleteUser |
Delete user from the database |
/api/v1/users/:userId:userId |
DELETE |
| createTransactionPin |
Create a transaction pin for performing sensitive actions |
/api/v1/users/transactions/create-pin |
POST |
| editTransactionPin |
Change a user's transaction pin |
/api/v1/users/transactions/edit-pin |
PUT |
| verifyTransactionPin |
Verify a transaction pin before allowing the user to proceed with sensitive action |
/api/v1/users/transactions/verify-pin |
POST |