latestOpenAPI 3.1.02026-07-26294215839.4 KB

19ebf391a399

Employee Verification
Public API

Enable or disable the employee verification integration

Enables or disables the company's employee verification integration. Enabling installs the configured partner app and schedules the daily sync; the company must have a valid US work location before enabling, otherwise a 400 is returned. Disabling tears down the partner app. The call is idempotent: a request to enable when already enabled (or disable when already disabled) returns 200 with the current state. Requires the employee_verifications.write OAuth scope, intended for admin-level API consumers.

OAuth Scopes: employee_verifications.write

put/api/v1/employee-verifications/integration

Request body

enabledboolean required

Desired enabled state for the integration.

Response

Success