Employment Hero Payroll API Reference: Recover Forgotten Password

Sends an email so that the user can reset their password

Request

POST https://api.yourpayroll.co.uk/api/v2/ess/security/forgottenpassword

Request body

The request body takes a complete RecoverPasswordModel resource, containing the following writable properties:

{
    "messageType": "string",
    "username": "string"
}

Properties

Name	Type	Description
messageType	string	MessageTypeEnum Possible values are: `NewPaySlipAvailable` `NewUser` `RecoverPassword` `EmployeeAccess` `BusinessAccess` `Invoice` `InvoicePaymentSuccessNotification` `AutomatedPassword` `LeaveRequestNotification` `RestrictedAccess` `ResendPayslip` `PaymentSummaryAvailable` `SuperPaymentsUpdateResults` `InvoicePaymentFailedNotification` `NewShiftsPublished` `ShiftsUnpublished` `ShiftDeclined` `KioskAccessGranted` `DailyNotifications` `BsbDataImported` `InvoiceeCardDetailsRemoved` `WhiteLabelManagerAccess` `ResellerAccess` `DirectDepositReminder` `ExpenseRequestNotification` `UnavailabilityNotification` `ReportPackGenerated` `ReportPackError` `SystemPublicHolidayImport` `TimesheetRejected` `ShiftRepublished` `PendingShiftsReminder` `EmployeeShiftActionTimeout` `InitiateEmployeeOnboarding` `FollowUpEmployeeOnboarding` `CompleteEmployeeOnboarding` `NewShiftsPreAccepted` `PayRunTaskNotification` `ShiftSwapCancelled` `BulkShiftSwapsCancelled` `ShiftSwapAwaitingApproval` `ShiftSwapProposed` `ShiftSwapAccepted` `ShiftSwapDeclined` `ShiftSwapRejected` `ShiftSwapApproved` `P60Available` `P60Error` `LeavingEmployeeFormNotification` `AutoEnrolmentNotification` `LodgementNotification` `TwoFactorLogin` `TwoFactorChallenge` `ConfirmEmailAddress` `ConfirmMobilePhone` `DocumentNotificationInitial` `DocumentNotificationInitialWithAcknowledgement` `DocumentNotificationReminder` `DocumentAcknowledgedNotification` `InitiateEmployeeOnboardingAdmin` `PayEventRequestAuthority` `PayEventApprovedOrRejected` `ShiftBidAccepted` `EmployeeDetailsUpdated` `BankAccountDetailsUpdated` `SuperDetailsUpdated` `ManagerShiftActionTimeout` `SuperFundNotificationNewMember` `SuperPaymentDishonour` `KiwiSaverDetailsUpdated` `AutoEnrolmentPostponementNotification` `AutomatedPayRunErrorCreation` `AutomatedPayRunErrorProcessing` `AutomatedPayRunErrorFinalisation` `AutomatedPayRunErrorPostFinalise` `AutomatedPayRunSuccessAndFinalised` `AutomatedPayRunSuccessNotFinalised` `AutomatedPayRunCreation` `PayRunUsageBillingFailures` `IncomeStatementAvailable` `MaliciousFileNotificationAdmin` `UserAccountLocked` `MaliciousFileNotificationEmployee` `SuperFundRefundNotification` `SuperBatchCancelledNotification` `JobKeeperEmployeeNomination` `HmrcPaymentReminder` `IrasFormAvailable` `HmrcPaymentReminderSendFailure` `SyncCancelledSuperBatchesFromBeam` `EAFormIncomeTaxAvailable` `PCB2FormAvailable` `JobMakerEmployeeNomination` `EarningsCertificateAvailable` `P11dAvailable` `PayRunApprovalNotification` `PayRunApprovalReminder` `PayRunStatusChanged` `QualificationUpdatedNotification` `QualificationExpiringNotification` `QualificationExpiredNotification` `CreditCardExpiringReminder` `ResendPaymentAndDeductionStatement` `EmployeeSelfSetupReminder` `EmployeeOnboardingP45Uploaded` `BusinessAccessGranted` `InitiateEmployeeOnboardingWithContract` `SignatoryContract` `WorkEligibilityExpiringNotification` `WorkEligibilityExpiredNotification` `ContractSignedEmployeeNotification` `ContractSignedEmployerNotification` `InitiateEmployeeOnboardingWithLogin` `AuthorisingSignatoryNotification` `IntegrationCustomFeatureRequest` `UserAccountLockedByAdmin` `UserAccountUnlockedByAdmin` `EmailAddressChanged` `EmailAddressConfirmChanged` `RecoveryEmailAddressChanged` `RecoveryEmailAddressConfirmChanged` `FraudProtectionCheckResult` `SuspiciousLogin` `ImpossibleTravelLogin` `PaymentApprovalNotification` `PaymentApprovalReminder` `PaymentApprovalStatusChanged` `BulkActionUserPasswordChanged` `BulkActionUserAccountLocked` `BulkActionUserAccountUnlocked` `P60DownloadReady` `PartnerBusinessDeactivationNotification30Days` `EHDirectBusinessDeactivationNotification30Days`
username	string	Required

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code	Description	Resource
200	OK OK