Create an employment eligibility verification

post

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

Opens a Form I-9 for a payee in a payer-payee relationship, in status PendingPayeeCompletion. Section 1 is pre-filled from the payee's profile.

Supplying an externalId already in use for this payer account returns 409 ResourceConflict — create is not an upsert.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Open a Form I-9 inside a payer-payee relationship. Both parties are resolved from payerPayeeId, so either side can call this. A payee must cite the requirementId it satisfies (400 without it); a payer may omit it. Repeat calls citing the same requirementId return the verification already open.

payerPayeeId

string

required

The PayerPayee record. A relationship that does not resolve, or one the calling Account holds no seat on, returns 404.

requirementId

string

The EmploymentEligibilityVerification Requirement this verification satisfies. Required for the payee, optional for the payer. A requirement of another type or outside this relationship returns 422.

externalId

string

Caller-supplied reconciliation id, unique per payer account. Payer-only: 422 from the payee.

metadata

object

Payer-only, like externalId.

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

201Employment eligibility verification created

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

422Validation error

501This operation is not yet available