Sign in

v1

latestOpenAPI 3.1.02026-07-241695611.0 MB
Employee Verification

Start Employee Verification Request

Start a new employee verification request.

post/employee_verification_requests

Headers

Preferstring nullable

Request execution preference (RFC 7240). Use respond-async for asynchronous execution, wait=N to specify a synchronous timeout hint in seconds, or priority=low to route the task to the low-priority queue.

Example:respond-async

Request execution preference (RFC 7240). Use respond-async for asynchronous execution, wait=N to specify a synchronous timeout hint in seconds, or priority=low to route the task to the low-priority queue.

Request body

person_namestring required

Full name of the person to verify.

business_namestring required

Name of the business to check against.

business_addressstring nullable

Business address for disambiguation.

alternative_namesstring[] nullable

Alternative names for the business (e.g., DBA names).

Response

Response

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.