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
- Base URLhttps://companySubDomain.bamboohr.com
- AuthOAuth 2Authorization code/authorize.phpToken URL/token.phpScopesemployee_verifications.write
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Response
Success
Changes
No recorded changes to this operation across all 2 revisions of this API.