Webhook Events

EmployeeVerificationRequest.completed

Emitted when an Employee Verification Request has completed and results are available.

postWebhookEmployeeVerificationRequest.completed

Payload

idstring uuid required

ID of the employee verification request.

created_atstring date-time required

When the request was created.

updated_atstring date-time nullable

When the request was last updated.

state'PENDING' | 'EXECUTING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' required

person_namestring required

Full name of the person being verified.

business_namestring required

Name of the business being checked.

business_addressstring nullable

Business address provided for disambiguation.

alternative_namesstring[] nullable

Alternative names provided for the business.

verifiedboolean nullable

Whether the person was verified as an employee.

role_titlestring nullable

Job title or role, if discovered.

departmentstring nullable

Department, if discovered.

evidence_summarystring nullable

Summary of evidence found.

Successful Response

unknown required

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.