Skip to main content
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

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

  1. Call this endpoint to get potential duplicate pairs
  2. Review each suggestion manually
  3. Use the /user/link-accounts endpoint to merge confirmed duplicates
  4. Repeat periodically to catch new potential duplicates

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successfully retrieved match suggestions

message
string
data
object