User Endpoints

{
  "id": "USER123",
  "firstName": "John",
  "lastName": "Doe",
  "dateOfBirth": "1990-01-01",
  "email": {
    "email": "john@example.com",
    "isVerified": false
  },
  "lastLogin": 1734167723000,
  "timestamp": 1734167723000
}

{
  "id": "USER123",
  "status": "success"
}

{
  "userId": "USER123",
  "onboardingFeedback": {
    "id": "FEEDBACK123",
    "status": "APPROVED",
    "description": "All verification checks passed",
    "createdAt": 1734167723000,
    "type": "KYC"
  },
  "kycDetail": {
    "sourceOfIncome": "employment",
    "kycStatus": "verified",
    "kycSource": "jumio",
    "kycStatusMessage": "Identity verified successfully"
  },
  "amlDetail": {
    "amlStatus": "cleared",
    "amlSource": "refinitiv"
  }
}

{
  "message": "Feedback processed successfully",
  "userId": "USER123"
}

{
  "error": {
    "type": "ERROR_TYPE",
    "message": "Human-readable error description",
    "details": ["Additional error details (optional)"]
  },
  "timestamp": 1755602195137
}

{
    "error": {
        "type": "VALIDATION_ERROR",
        "message": "Request validation failed",
        "details": [
            "/id: Expected string"
        ]
    },
    "timestamp": 1755602195137
}

{
  "user": {
    "id": "USER123",
    "createdAt": 1734067723000,
    "updatedAt": 1734167723000,
    "firstName": "John",
    "lastName": "Doe",
    "status": "active",
    "reason": "User previously blocked for suspicious activity" 
  }
}

{
  "user": {
    "id": "USER123",
    "createdAt": 1734067723000,
    "updatedAt": 1734167723000,
    "firstName": "John",
    "lastName": "Doe",
    "status": "active",
    "reason": "User previously blocked for suspicious activity"
  }
}

{
  "comment": "Suspicious activity detected",
  "reviewer": "john.smith"
}

{
  "comment": "User verified identity",
  "reviewer": "jane.doe"
}

{
  "status": "inactive",
  "closureType": "user_requested",
  "comment": "User requested account closure",
  "initiatedBy": "support.team",
  "reason": "NO_REASON",
  "completedAt": 1734167723000
}

{
  "users": [
    {
      "id": "USER123",
      "status": "BLOCKED",
      "updatedAt": 1734167723000
    },
    {
      "id": "USER456",
      "status": "BLOCKED",
      "updatedAt": 1734167723000
    }
  ],
  "total": 45,
  "cursor": "USER456"
}

{
  "status": "blocked",
  "parties": "user",
  "comment": "Fraudulent transaction detected",
  "reviewer": "fraud.detection.team"
}

{
  "attribute": "deviceFingerprint",
  "value": "fp_abcdef123456",
  "status": "BLOCKED",
  "comment": "Device linked to multiple fraudulent accounts",
  "reviewer": "risk.team"
}

type UserStatus =
  | 'ACTIVE' | 'INACTIVE' | 'BLOCKED'   // stored as-is
  | 'PENDING' | 'APPROVED'              // both stored as active
  | 'DECLINED';                         // stored as inactive
 
interface User {
  id: string;                    // Unique user identifier
  timestamp: number;             // Unix timestamp in milliseconds, must not be in the future
  firstName?: string;
  lastName?: string;
  dateOfBirth?: string;         // Required for age-related rules
  address?: Address;
  company?: string;             // Company name for grouping users
  taxNumberId?: string;
  guest?: boolean;              // Guest rather than a registered account
  phone?: {
    phone: string;              // E.164 formatted
    country?: string;           // ISO 3166-1 alpha-2
    isVerified?: boolean;
  };
  email?: {
    email: string;
    isVerified?: boolean;
  };
  documents?: UserDocument[];
  lastLogin?: number;
  userDevice?: UserDevice;
  status?: UserStatus;
  amlDetail?: {
    amlStatus?: string;
    amlSource?: string;
  };
  kycDetail?: {
    sourceOfIncome?: string;
    kycStatus?: string;
    kycSource?: string;
    kycStatusMessage?: string;
  };
  salary?: {
    cycle: 'weekly' | 'bi-weekly' | 'monthly';
    amount: number;
    currency: string;           // ISO 4217
  };
  onboardingFeedback?: {
    id?: string;
    status?: UserStatus;
    description?: string;
    createdAt?: number;
    type?: string;
  };
  referralCode?: string;
  referrerCode?: string;
}

interface UserDocument {
  country?: string;    // Country of document issue
  number?: string;     // Document identification number
  type?: string;       // Document type (passport, ID card, driver's license)
  source?: string;     // Source of document verification
  fullName?: string;   // Full name as appears on the document
}