URL Expired

The URL for this request expired after 30 days.

Request body for I9Center setup endpoint. This endpoint configures I-9 and W-4 form processing for a company. All fields are optional. If omitted, sensible defaults will be applied. The endpoint will create or update the company's onboarding provider configuration with Workbright as the default provider for both I-9 and W-4 forms. MULTI-EIN SUPPORT: By default, the system creates one Workbright credential per EIN when multiple EINs are configured. Each Workbright credential is linked to its EIN, and the default EIN's Workbright credential is marked as the default credential. To override this behavior and use a single shared Workbright credential for all EINs, set useOneWbCredentialForAllEin=true or provide manual Workbright credentials (wbApiKey). If hireAccountUuid is provided, the system will configure Fountain Hire integration using the provided hireAccountUuid and PAPI credentials. PAPI credentials (papiAccountUuid, papiAccountApiKey, partnerGatewayBaseUrl) can be optionally provided in the request body. If not provided, the system will use default PAPI credentials. If hireAccountUuid is not provided, PAPI setup will be skipped and hirePapiSettings will not be set in the configuration. This is designed for one-call setup by AI agents, allowing flexibility to customize PAPI credentials per company or use system defaults. AI OUTPUT RULE FOR UPDATE REQUESTS: build a MINIMAL PATCH only. Include ONLY fields explicitly provided by the user in the current request. Do NOT infer/backfill from prior messages or fetched data. Do NOT send empty string, null, undefined, default false, or unchanged values unless explicitly requested.

Settings

eVerifyEnabled
Type: boolean
Enable E-Verify integration. E-Verify is an internet-based system that compares information from an employee's Form I-9 to data from U.S. government records to confirm employment eligibility. When enabled, the system will automatically verify new hires through E-Verify. Set to true to enable E-Verify, false to disable, or omit to use the default (false).

skipEVerifyStates
Type: array of strings
List of U.S. state codes (two-letter abbreviations) where E-Verify should be skipped, even if eVerifyEnabled is true.

skipEVerifyByJobs
Type: array of strings
List of job UUIDs where E-Verify should be skipped.

keepTaskInProgressUntilSection2Completion
Type: boolean
When true, keeps the I-9 task in "in progress" status until Section 2 of the I-9 form is completed.

section2CompletionIgnoresReceipts
Type: boolean
When true, unsubmitted receipt documents do not block I-9 completion after Section 2 is countersigned. Defaults to false.

resetI9OnInformationChange
Type: boolean
When true, automatically resets the I-9 form when worker information changes. Defaults to false.

resetI9OnRehire
Type: boolean
When true, automatically resets the I-9 form when a worker is rehired. Defaults to false.

resetW4OnRehire
Type: boolean
When true, automatically resets the W-4 form when a worker is rehired. Defaults to false.

importProvider
Type: string enum
The provider service to use for importing worker data into the onboarding system. Use "hire" to enable Hire.com integration, "none" to disable worker imports, or omit to use the default (none).

w4StateTaxReciprocity
Type: boolean
Enable state tax reciprocity for W-4 forms. Defaults to true.

w4GroupCode
Type: string
The W-4 group code used for organizing and categorizing W-4 forms. Defaults to "AFPU".

wbApiKey
Type: string
The Workbright API key for authenticating API requests to Workbright services. Required to communicate with Workbright for I-9 and W-4 form processing.

wbSubdomain
Type: string
The Workbright subdomain for your organization's Workbright instance. Required for connecting to the correct Workbright account.

wbProviderDomain
Type: string
The Workbright provider domain suffix. Defaults to ".workbright.fountain.com".

wbDefaultEmployeeId
Type: string
The default employee ID to use when creating new employee records in Workbright. Defaults to "1".

hireAccountUuid
Type: uuid
OPTIONAL: The Hire account UUID that identifies the Fountain Hire account to connect with this onboarding provider configuration.

papiAccountUuid
Type: uuid
OPTIONAL: The PAPI account UUID for authenticating with Hire.com's Partner API.

papiAccountApiKey
Type: string
OPTIONAL: The PAPI account API key for authenticating API requests to Hire.com's Partner API.

partnerGatewayBaseUrl
Type: uri
OPTIONAL: The base URL for the Hire.com Partner Gateway API.

lockSection2WorkerOnPortal
Type: boolean
OPTIONAL: When true, prevents workers from being redirected to Hire.com for Section 2 completion. Defaults to false.

workerTokenDurationInMinutes
Type: integer
OPTIONAL: The duration in minutes for worker access tokens. Defaults to 30 minutes.

papiStageSettings
Type: array of objects
OPTIONAL: Array of PAPI stage settings that define which onboarding tasks are available and how they are configured.

useOneWbCredentialForAllEin
Type: boolean
When true, uses a single shared Workbright credential for all EINs. Defaults to false.

everifyAccountsByEin
Type: array of objects
Optional array of E-Verify account entries.

registrationInfosByEin
Type: array of objects
Optional array of registration information object per EIN.

200 I9Center setup completed successfully

ShellNode

curl --request POST \n     --url https://services.fountain.com/api/serviceemployment/processes/i9center/setup \n     --header 'accept: application/json' \n     --header 'content-type: application/json'

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

application/json

``200

Updated 3 months ago