Sign in

v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
i9center

One stop setup for I9Center V2

post/api/serviceemployment/processes/i9center/setup

Request body

eVerifyEnabledboolean

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).

skipEVerifyStatesstring[]

List of U.S. state codes (two-letter abbreviations) where E-Verify should be skipped, even if eVerifyEnabled is true. This is useful for states that have restrictions on E-Verify usage or when certain states should be excluded from verification. Each element should be a valid two-letter state code (e.g., "CA", "NY", "TX").

skipEVerifyByJobsstring[]

List of job UUIDs where E-Verify should be skipped. This allows you to exclude specific job positions from E-Verify verification. Each element should be a valid UUID string. Useful when certain job types or positions should not be subject to E-Verify requirements.

keepTaskInProgressUntilSection2Completionboolean

When true, keeps the I-9 task in "in progress" status until Section 2 of the I-9 form is completed. Section 2 is the employer verification section that must be completed within 3 business days of the employee's start date. This setting ensures the task remains active until the employer completes their portion. Set to true to enable this behavior, false to allow task completion after Section 1, or omit to use the default (false).

section2CompletionIgnoresReceiptsboolean

When true, unsubmitted receipt documents do not block I-9 completion after Section 2 is countersigned. The section2 step advances to "completed" immediately, unblocking E-Verify processing. Defaults to false.

resetI9OnInformationChangeboolean

When true, automatically resets the I-9 form when worker information changes (e.g., name, date of birth, SSN). This ensures I-9 forms stay current with worker data. Set to true to enable automatic resets, false to disable, or omit to use the default (false).

resetI9OnRehireboolean

When true, automatically resets the I-9 form when a worker is rehired. This ensures a fresh I-9 is completed for each new employment period. Set to true to enable automatic resets on rehire, false to disable, or omit to use the default (false).

resetW4OnRehireboolean

When true, automatically resets the W-4 form when a worker is rehired. This ensures workers can update their tax withholding preferences for each new employment period. Set to true to enable automatic resets on rehire, false to disable, or omit to use the default (false).

importProvider'none' | 'hire'

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).

w4StateTaxReciprocityboolean

Enable state tax reciprocity for W-4 forms. When enabled, the system will handle state tax reciprocity agreements where workers who live in one state but work in another may be exempt from withholding in the work state. Set to true to enable reciprocity handling, false to disable, or omit to use the default (true).

w4GroupCodestring

The W-4 group code used for organizing and categorizing W-4 forms. This is typically a company-specific code used for internal tracking and reporting. Should be a short alphanumeric string. If not provided, defaults to "AFPU".

wbApiKeystring

The Workbright API key for authenticating API requests to Workbright services. Must be exactly 64 hexadecimal characters (0-9, a-f, A-F). This key is required to communicate with Workbright for I-9 and W-4 form processing. The key will be encrypted before storage. If not provided, a placeholder key will be used for testing purposes.

wbSubdomainstring

The Workbright subdomain for your organization's Workbright instance. This is the unique identifier that appears in your Workbright URL (e.g., if your URL is "company.workbright.com", the subdomain is "company"). Required for connecting to the correct Workbright account. If not provided, defaults to "fountain-sandbox" for testing.

wbProviderDomainstring

The Workbright provider domain suffix. This is typically ".workbright.fountain.com" for Fountain-managed Workbright instances. Used to construct the full Workbright API endpoint URL. If not provided, defaults to ".workbright.fountain.com".

wbDefaultEmployeeIdstring

The default employee ID to use when creating new employee records in Workbright. This is used as a fallback when no specific employee ID is provided. Typically set to "1" or another default identifier. If not provided, defaults to "1".

hireAccountUuidstring uuid

OPTIONAL: The Hire account UUID that identifies the Fountain Hire account to connect with this onboarding provider configuration. This is the external account identifier from Fountain Hire that will be used for worker data import (PAPI Partner API) and synchronization. If provided, the system will configure fountainHire settings along with PAPI credentials. If not provided, PAPI setup will be skipped and hirePapiSettings will not be set in the configuration and WX I9 Center will be configured without Hire.

papiAccountUuidstring uuid

OPTIONAL: The PAPI account UUID for authenticating with Hire.com's Partner API. This is the external PAPI account identifier in Hire.com used for partner API authentication. If not provided, the system will use default PAPI credentials. Provide this value if you need to use a specific PAPI account for this company.

papiAccountApiKeystring

OPTIONAL: The PAPI account API key for authenticating API requests to Hire.com's Partner API. This key is required to communicate with Hire.com for worker data import and synchronization. If not provided, the system will use default PAPI credentials. Provide this value if you need to use a specific PAPI API key for this company.

partnerGatewayBaseUrlstring uri

OPTIONAL: The base URL for the Hire.com Partner Gateway API. This is the endpoint used to update partner status and details in Hire.com. Typically this is the partners API base URL (e.g., "https://partners-api.fountain.com/"). If not provided, the system will use the default Partner Gateway URL. Provide this value if you need to use a specific Partner Gateway endpoint for this company.

lockSection2WorkerOnPortalboolean

OPTIONAL: When true, prevents workers from being redirected to Hire.com even when they book a Section 2 appointment (video call or on-site appointment). Section 2 is the employer verification section of the I-9 form. This setting allows you to keep workers on the portal instead of redirecting them to Hire.com for Section 2 completion. Set to true to lock workers on the portal, false to allow redirects, or omit to use the default (false).

workerTokenDurationInMinutesinteger

OPTIONAL: The duration in minutes for worker access tokens. This determines how long a worker's authentication token remains valid before they need to refresh it. Longer durations provide better user experience but may pose security risks. Shorter durations are more secure but may require workers to re-authenticate more frequently. If not provided, defaults to 30 minutes.

useOneWbCredentialForAllEinboolean

When true, uses a single shared Workbright credential for all EINs. When false (default), creates one Workbright credential per EIN. Ignored if manual Workbright credentials (wbApiKey) are provided.

Example request

{
  "skipEVerifyStates": [
    "CA",
    "NY"
  ],
  "skipEVerifyByJobs": [
    "123e4567-e89b-12d3-a456-426614174000",
    "123e4567-e89b-12d3-a456-426614174001"
  ],
  "importProvider": "none",
  "w4StateTaxReciprocity": true,
  "w4GroupCode": "AFPU",
  "wbApiKey": "0000000000000000000000000000000000000000000000000000000000000000",
  "wbSubdomain": "fountain-sandbox",
  "wbProviderDomain": ".workbright.fountain.com",
  "wbDefaultEmployeeId": "1",
  "hireAccountUuid": "00007da6-8545-4b2c-9712-8748f26fca08",
  "papiAccountUuid": "ad87cafb-eae6-4f12-864d-45685cd8ce78",
  "papiAccountApiKey": "fb8db15b-f9e3-43fa-abe4-24891f4f1b9f",
  "partnerGatewayBaseUrl": "https://partners-api.fountain.com/",
  "workerTokenDurationInMinutes": 30,
  "papiStageSettings": [
    {
      "id": "id_1",
      "stageOption": "I9"
    },
    {
      "id": "id_2",
      "stageOption": "W4"
    },
    {
      "id": "id_4",
      "stageOption": "I9 and W4"
    }
  ],
  "everifyAccountsByEin": [],
  "registrationInfosByEin": []
}

Response

I9Center setup completed successfully

Example response

{
  "data": {
    "success": true,
    "i9Setup": true,
    "papiSetup": true,
    "einMode": "single",
    "credentialsCreated": 1,
    "settingsUpdated": true
  },
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}