Sign in

v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Employee Verification
Public API

Send employee verification lifecycle email by user and email type

Accepts a Bamboo userId (path) and an emailType (body) and queues the corresponding employee verification lifecycle email—the same templates as the in-app auth listener (signup_survey after signup, app_installed after the integration app is installed). Delivered to the company owner contact with template context for that user id. Not an employee I-9 reminder. Requires the employee verification integration enabled, onboarding edit access, and employee_verifications.write.

OAuth Scopes: employee_verifications.write

post/api/v1/employee-verifications/users/{userId}/send-email

Path parameters

userIdinteger required

Bamboo user id for the requesting user in the email template (same role as the listener’s event user id). Together with body emailType, selects which verification email to send.

Request body

emailType'signup_survey' | 'app_installed' required

Which employee verification lifecycle email to send; must be {@see EverifyEmailType::SIGNUP_SURVEY} or {@see EverifyEmailType::APP_INSTALLED} (string values signup_survey, app_installed).

Response

Request accepted; email has been queued for delivery.

statusstring required
messagestring

Example response

{
  "status": "accepted",
  "message": "Employee verification email has been queued for delivery."
}