v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Employee Verification
Public API

Update an employee verification record

Partial update of a single employee verification row. Any field omitted from the request body is left unchanged. Returns 404 when the verification id does not exist or does not belong to {employeeId}. Most verification updates flow in via partner webhooks; this endpoint exists for admin-level integrations that need to correct or annotate a record out-of-band, and requires onboarding view-and-edit permission on the employee.

OAuth Scopes: employee_verifications.write

put/api/v1/employee-verifications/employees/{employeeId}/{verificationId}

Path parameters

employeeIdinteger required

The internal employee ID of the employee who owns the verification row.

verificationIdinteger required

Identifier of the verification record to update.

Request body

verificationType'in-person' | 'hybrid' | 'remote' nullable
verificationStatus'pending' | 'inprogress-section-1' | 'inprogress-section-2' | 'completed' | 'failed' nullable
verificationStatusNotesstring nullable
remoteAccessUrlstring nullable
eVerifyStatus'pending' | 'inprogress' | 'completed' | 'failed' nullable

Response

Success — returns the updated verification record.