Skip to main content
GET
/
reports#getUser
getUser
curl --request GET \
  --url 'https://sandbox.rollfi.xyz/reports#getUser' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "<string>",
  "companyId": "<string>",
  "userId": "<string>"
}
'
{
  "user": [
    {
      "user": "<string>",
      "userId": "<string>",
      "companyId": "<string>",
      "status": {
        "userStatus": "<string>"
      },
      "WorkerType": {
        "WorkerType": "<string>"
      },
      "firstName": "<string>",
      "lastName": "<string>",
      "middleName": "<string>",
      "phoneNumber": "<string>",
      "kycStatus": "<string>",
      "jobTitle": "<string>",
      "dateOfJoin": "<string>",
      "email": "<string>",
      "userWages": [
        {
          "WageRate": 123,
          "WageBasis": {
            "WageBasis": "<string>"
          },
          "paymentMethod": {
            "PaymentMethod": "<string>"
          },
          "employeeRefTaxExempt": "<string>",
          "employeeType": "<string>",
          "differentialPay": "<string>",
          "employmentStatus": "<string>"
        }
      ],
      "userAddress": {
        "address1": "<string>",
        "address2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipcode": "<string>",
        "country": "<string>"
      },
      "companyLocationCategory": {
        "companyLocationCategory": "<string>"
      },
      "companyLocation": {
        "companyLocation": "<string>",
        "companyLocationId": "<string>",
        "Address1": "<string>",
        "Address2": "<string>",
        "City": "<string>",
        "Country": "<string>",
        "State": "<string>",
        "Zipcode": "<string>",
        "address": "<string>"
      },
      "stateCode": "<string>",
      "W4Informations": [
        {
          "W4FilingStatus": {
            "W4FilingStatus": "<string>"
          },
          "HaveMultipleJob": true,
          "Dependents": 123,
          "DependentsAbove18": 123,
          "OtherIncome": 123,
          "OtherDeduction": 123,
          "ExtraWithholding": 123,
          "HasMilitarySpouseExemption": true,
          "StateAdditionalDeduction": 123,
          "IsNonResident": true,
          "AZDeductionPercent": 123
        }
      ],
      "ssn": "<string>",
      "dateOfBirth": "<string>",
      "stateW4Informations": [
        "<string>"
      ],
      "bankAccounts": [
        {
          "userPayAccountEntityId": "<string>",
          "bankName": "<string>",
          "accountName": "<string>",
          "accountNumber": "<string>",
          "payPercentage": 123,
          "accountType": "<string>"
        }
      ]
    }
  ]
}

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
method
string
required
companyId
string
required
userId
string
required

Response

user
object[]
required