Update an employment eligibility verification

patch

https://api.wingspan.app/v3/compliance/employment-eligibility-verifications/{employmentEligibilityVerificationId}

Partial update via JSON Merge Patch (RFC 7396). The payee updates the Section 1 citizenship fields while the status is PendingPayeeCompletion; the payer updates Sections 2 and 3, externalId and metadata while the status is PendingPayerCompletion.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

employmentEligibilityVerificationId

string

required

Unique identifier of an EmploymentEligibilityVerification.

Body Params

Partial update via JSON Merge Patch (RFC 7396). The payee may update the citizenship fields of employeeProfile while the status is PendingPayeeCompletion. The payer may update verificationProcess, documents, firstDayOfEmployment, notes, verifierProfile, externalId and metadata while the status is PendingPayerCompletion. A field the caller may not write returns 422; a field outside its status returns 409.

employeeProfile

object

Section 1 of Form I-9. The identity fields come from the payee's profile on file and are read-only: until the payee submits, the payee sees them as currently on file; on submit they are saved with the verification. The payee writes only the citizenship fields.

verificationProcess

string

enum

How the payer examined the documents. Remote is the alternative procedure authorized by DHS and requires the payer to be enrolled in E-Verify.

Allowed:

documents

array of objects

documents

firstDayOfEmployment

date

eVerifyReasonForDelayCode

string

eVerifyReasonForDelayDescription

string

length ≤ 256

notes

string

length ≤ 500

verifierProfile

object

The employer or authorized representative who examined the documents and signs Section 2 of Form I-9. The name comes from the person who verifies, and the business name and address from the payer account: until the payer verifies, the payer sees them as currently on file; on verify they are saved with the verification. The payer writes title, firstName and lastName when the person who verifies has no legal name on file, and phone when no US phone is on file.

externalId

string

metadata

object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers

Idempotency-Key

string

length between 1 and 255

^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Updated employment eligibility verification

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

422Validation error