addBusinessContractor

The addBusinessContractor API creates a new business contractor who interacts with the company payroll.

What it does:

• Creates a business contractor user with address, KYB (Know Your Business) data, wage and company location
• Records the ownership share of the business user in their respective company

Notes:

• Different from regular contractors created with addUser - this is specifically for business contractors
• Business contractors are separate from business users who have administrative roles

POST /adminPortal#addBusinessContractor

addBusinessContractor

cURL

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/adminPortal#addBusinessContractor' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "addBusinessContractor",
  "user": {
    "companyId": "A141A4B1-C742-4C43-9A45-E8CCC2FD87F7",
    "legalName": "Pear Inc",
    "firstName": "Meery",
    "middleName": "Austin",
    "lastName": "Steve",
    "email": "[e-mail]",
    "phoneNumber": "9889890989",
    "dateOfJoin": "2000-01-01",
    "jobTitle": "Manager",
    "companyLocationCategory": "Remote",
    "code": "FL"
  },
  "userWage": {
    "differentialPay": "No",
    "wageRate": 1110,
    "workerType": "W2",
    "wageBasis": "Per Week",
    "userType": "Salary/Eligible for overtime",
    "employmentStatus": "Full Time (30+ Hours per week)",
    "userRefTaxExempt": "Yes, as an owner/corporate officer",
    "startDate": "2023-02-25",
    "paymentMethod": "Check"
  },
  "kybInformation": {
    "ein": "785698565",
    "dateOfIncorporation": "2023-02-25"
  },
  "companyLocation": {
    "address1": "8745 Colard Ln",
    "address2": "",
    "city": "Lyons",
    "state": "CO",
    "zipcode": "80540",
    "country": "US",
    "phoneNumber": "9889890989"
  },
  "businessUser": {
    "address1": "8745 Colard Ln",
    "address2": "",
    "city": "Lyons",
    "state": "CO",
    "zipcode": "80540",
    "country": "US",
    "dateOfBirth": "2000-09-09",
    "ownershipPercentage": 28
  }
}
'

200

{
  "businessContractor": {
    "companyId": "B06FF5C9-D654-4B6F-ABF0-072AF5A7D1CF",
    "kybInformationId": "51A02CD2-745A-4C77-B7C6-6711ABBD9EEE",
    "userId": "088B3C3C-F7C2-4F42-999A-CC1FA135CE82",
    "userWageId": "C62AD35C-5BDF-4B9F-9E0A-6C97A44730BF",
    "businessUserId": "088B3C3C-F7C2-4F42-999A-CC1FA135CE82",
    "companyLocationId": "401AB38E-5C90-48F1-BBEA-F7449B41DB80",
    "status": "Registered",
    "message": "A business contractor has been registered successfully and KYB verification is in progress."
  }
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

user · object · required

Show child attributes

kybInformation · object · required

Show child attributes

companyLocation · object · required

Show child attributes

businessUser · object · required

Show child attributes

Response

200

application/json

businessContractor · object · required

Show child attributes