Get suggested user account matches
User Administration
Get Match Suggestions
Admin-only endpoint that returns suggested user pairs that may represent the same person. Suggestions are generated by comparing emails and personal information (first name, last name, name).
GET
Get suggested user account matches
Admin-only endpoint that returns suggested user pairs that may represent the same person. Suggestions are generated by comparing emails and personal information (first name, last name, name).
Request
Headers
| Name | Type | Required | Description |
|---|---|---|---|
| Authorization | string | Yes | Bearer token |
Response
200 OK - Successfully retrieved match suggestions
401 Unauthorized
500 Internal Server Error
Example
Notes
- This is an admin-only endpoint - requires administrative privileges
- Suggestions are based on similarity of emails and personal information
- Each suggestion is an array of 2 users that may represent the same person
- The match score indicates confidence level (0.0 to 1.0)
- Higher scores indicate stronger matches
- Use these suggestions to identify potential duplicate accounts
- After reviewing, use the link-accounts endpoint to merge duplicates
- The algorithm compares: email domains, names, and other personal data
- Suggestions are generated in real-time and may change as user data updates
Matching Criteria
The system considers the following when generating suggestions:- Email address similarity (same domain, similar local parts)
- Exact name matches (first and last name)
- Similar email patterns (e.g., john.doe vs j.doe)
- Phone number matches
- Department and role similarities
Usage Workflow
- Call this endpoint to get potential duplicate pairs
- Review each suggestion manually
- Use the
/user/link-accountsendpoint to merge confirmed duplicates - Repeat periodically to catch new potential duplicates