EVeveree

Create contractor for embedded onboarding

The rest of the contractor’s information will be captured during the embedded onboarding process. Note that this operation will designate the worker as a 1099-issued contractor without a formal employment relationship.

post/integration/v1/embedded/workers/contractor

Request

  • Base URL
    https://api.everee.com
  • URL
    https://api.everee.com/integration/v1/embedded/workers/contractor
  • Auth
    API key in header Authorization

Request body

firstNamestring required
middleNamestring
lastNamestring required
phoneNumberstring required

10 digits

emailstring required

email format

startDatestring date required

ISO8601 date

externalWorkerIdstring
approvalGroupIdinteger

The group to assign this contractor to.

Response

201

idstring

The worker's identifier: your external worker ID if one has been set, otherwise Everee's generated worker ID. Use this value in the {id} path parameter of worker endpoints.

firstNamestring
middleNamestring
lastNamestring
phoneNumberstring

10 digits

emailstring

email format

onboardingCompleteboolean
hireDatestring date

ISO8601 date

terminationDatestring date

ISO8601 date. Only present once the worker has been separated.

dateOfBirthstring date

ISO8601 date

taxpayerIdentifierstring

9-digit numeric string (no hyphens or other characters)

tinVerificationStatus'NEEDS_VERIFICATION' | 'SENT_FOR_VERIFICATION' | 'VERIFIED' | 'VERIFICATION_FAILED' | 'UNABLE_TO_VERIFY'

"NEEDS_VERIFICATION": TIN is pending verification "SENT_FOR_VERIFICATION": TIN has been submitted for verification "VERIFIED": TIN was verified successfully "VERIFICATION_FAILED": TIN failed verification and requires update "UNABLE_TO_VERIFY": TIN could not be submitted for verification

typicalWeeklyHoursinteger

integer in range 1-40 inclusive (employees only)

preferredPaymentMethod'DIRECT_DEPOSIT' | 'PAY_CARD'

"DIRECT_DEPOSIT": worker is paid via ACH to a bank account "PAY_CARD": worker is paid on an Everee-managed pay card

documentGroupsstring[]

Names of the company document groups assigned to the worker.

Example response

{
  "id": "emp-1001",
  "firstName": "Johnny",
  "middleName": "B",
  "lastName": "Appleseed",
  "phoneNumber": "8002029399",
  "email": "johnny@appleseed.com",
  "onboardingComplete": true,
  "hireDate": "2024-01-15",
  "dateOfBirth": "1990-05-20",
  "taxpayerIdentifier": "123456789",
  "tinVerificationStatus": "VERIFIED",
  "typicalWeeklyHours": 40,
  "preferredPaymentMethod": "DIRECT_DEPOSIT",
  "approvalGroup": {
    "id": "123",
    "name": "Warehouse"
  },
  "position": {
    "payType": "HOURLY",
    "payRate": {
      "amount": "25.00",
      "currency": "USD"
    },
    "title": "Packer"
  },
  "homeAddress": {
    "line1": "123 Main St",
    "city": "Austin",
    "state": "TX",
    "postalCode": "78701"
  },
  "bankAccounts": [
    {
      "bankName": "BANK OF AMERICA, N.A.",
      "accountName": "Checking",
      "accountType": "CHECKING",
      "routingNumber": "111000025",
      "accountNumberLast4": "6789"
    }
  ],
  "legalWorkAddress": {
    "useHomeAddress": true,
    "name": "Home address",
    "address": {
      "line1": "123 Main St",
      "city": "Austin",
      "state": "TX",
      "postalCode": "78701"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.