Skip to main content
GET
/
v1
/
users
/
{user_id}
/
reports
/
{report_id}
Retrieve an income and employment report
curl --request GET \
  --url https://prod.truv.com/v1/users/{user_id}/reports/{report_id}/ \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>'
{
  "report_id": "48427a36d43c4d5aa6324bc06c692456",
  "created_at": "2022-05-04T11:30:00.000Z",
  "completed_at": "2022-05-04T12:00:00.000Z",
  "last_task_at": "2022-05-04T12:00:00.000Z",
  "links": [
    {
      "id": "24d7e80942ce4ad58a93f70ce4115f5c",
      "link_id": "150491a20bdb4292bb2a2ad8554fecba",
      "tracking_info": "<string>",
      "data_source": "payroll",
      "provider": "<string>",
      "provider_name": "<string>",
      "employments": [
        {
          "id": "24d7e80942ce4ad58a93f70ce4115f5c",
          "profile": {
            "first_name": "John",
            "last_name": "Doe",
            "home_address": {
              "street": "1 Morgan Ave",
              "city": "Los Angeles",
              "state": "CA",
              "zip": "90210",
              "country": "US"
            },
            "id": "48427a36d43c4d5aa6324bc06c692456",
            "created_at": "2022-06-07T15:00:00.000Z",
            "updated_at": "2022-06-30T15:00:00.000Z",
            "full_name": "John Doe",
            "middle_initials": "K",
            "email": "john.doe@example.com",
            "ssn": "123456789",
            "date_of_birth": "1992-03-03T00:00:00.000Z"
          },
          "company": {
            "name": "Facebook Demo",
            "address": {
              "street": "1 Morgan Ave",
              "city": "Los Angeles",
              "state": "CA",
              "zip": "90210",
              "country": "US"
            },
            "phone": "6503087300",
            "ein": "12-345678"
          },
          "income": "70000.00",
          "income_unit": "YEARLY",
          "pay_rate": "6500.00",
          "pay_frequency": "M",
          "statements": [
            {
              "pay_date": "2018-05-15T00:00:00.000Z",
              "id": "24d7e80942ce4ad58a93f70ce4115f5c",
              "check_number": "29205182",
              "net_pay": "11500.32",
              "net_pay_ytd": "31980.64",
              "gross_pay": "13900.11",
              "gross_pay_ytd": "49200.00",
              "bonus": "100.00",
              "commission": "12000.00",
              "hours": "40.00",
              "basis_of_pay": "S",
              "period_start": "2018-05-01T00:00:00.000Z",
              "period_end": "2018-05-15T00:00:00.000Z",
              "regular": "1695.11",
              "regular_ytd": "23000.00",
              "other_pay_ytd": "700.00",
              "bonus_ytd": "1000.00",
              "commission_ytd": "24000.00",
              "overtime": "45.00",
              "overtime_ytd": "500.00",
              "other_pay": "60.00",
              "earnings": [
                {
                  "name": "Regular",
                  "amount": "1935.77",
                  "category": "regular",
                  "rate": null,
                  "units": null
                },
                {
                  "name": "Overtime",
                  "amount": "60.58",
                  "category": "overtime",
                  "rate": "30.29",
                  "units": "2"
                }
              ],
              "earnings_ytd": [
                {
                  "name": "Regular",
                  "amount": "1935.77",
                  "category": "regular",
                  "rate": null,
                  "units": null
                },
                {
                  "name": "Overtime",
                  "amount": "60.58",
                  "category": "overtime",
                  "rate": "30.29",
                  "units": "2"
                }
              ],
              "deductions": [
                {
                  "name": "Social Security Tax",
                  "amount": "127.01",
                  "category": "socialsec"
                },
                {
                  "name": "VA State Income Tax",
                  "amount": "46.23",
                  "category": "state"
                },
                {
                  "name": "Medicare Tax",
                  "amount": "29.7",
                  "category": "medicare"
                }
              ],
              "deductions_ytd": [
                {
                  "name": "Social Security Tax",
                  "amount": "127.01",
                  "category": "socialsec"
                },
                {
                  "name": "VA State Income Tax",
                  "amount": "46.23",
                  "category": "state"
                },
                {
                  "name": "Medicare Tax",
                  "amount": "29.7",
                  "category": "medicare"
                }
              ],
              "md5sum": "03639d6a6624f69a54a88ea90bd25e9d",
              "file": "https://cdn.truv.com/paystub_sample.pdf",
              "derived_fields": [
                "basis_of_pay"
              ],
              "missing_data_fields": [
                "earnings_ytd"
              ]
            }
          ],
          "annual_income_summary": [
            {
              "id": "24d7e80942ce4ad58a93f70ce4115f5c",
              "year": 2018,
              "regular": "23000.00",
              "bonus": "1000.00",
              "commission": "24000.00",
              "overtime": "500.00",
              "other_pay": "700.00",
              "net_pay": "31980.64",
              "gross_pay": "49200.00"
            }
          ],
          "bank_accounts": [
            {
              "account_number": "1234567890",
              "routing_number": "123456789",
              "account_name": "My Bank",
              "account_type": "C",
              "deposit_type": "A",
              "deposit_value": "200.00",
              "bank_name": "TD Bank"
            }
          ],
          "w2s": [
            {
              "file": "https://cdn.truv.com/W2_sample.pdf",
              "md5sum": "f65e30c39124ad707ac4b3aeaee923a7",
              "year": 2020,
              "wages": "900.50",
              "federal_tax": "75.01",
              "social_security_wages": "900.50",
              "social_security_tax": "56.30",
              "medicare_wages": "900.50",
              "medicare_tax": "13.15",
              "gross_pay": "18211.48"
            }
          ],
          "is_active": false,
          "job_title": "PR associate",
          "job_type": "F",
          "start_date": "2018-01-01T00:00:00.000Z",
          "original_hire_date": "2017-06-21T00:00:00.000Z",
          "end_date": "2023-12-25",
          "external_last_updated": "2023-12-25",
          "derived_fields": [
            "is_active"
          ],
          "missing_data_fields": [
            "w2s"
          ],
          "manager_name": "Jenny McDouglas",
          "gse_accepted": true,
          "last_period_end": "2022-05-04T00:00:00.000Z",
          "last_pay_date": "2022-05-04T00:00:00.000Z"
        }
      ]
    }
  ]
}

Authorizations

​
X-Access-Client-Id
string
header
required

Client ID

​
X-Access-Secret
string
header
required

Client Access Key

Path Parameters

​
report_id
string
required
​
user_id
string
required

Query Parameters

​
report_type
enum<string>
default:payroll

Report type

Available options:
payroll,
aim_check
​
fmt
enum<string>
default:json

Response format

Available options:
json,
pdf

Response

​
report_id
string
required
read-only

Unique identifier of the report.

Maximum string length: 32
Example:

"48427a36d43c4d5aa6324bc06c692456"

​
created_at
string<date-time>
required
read-only

Timestamp when the report was created.

Example:

"2022-05-04T11:30:00.000Z"

​
completed_at
string<date-time>
required
read-only

Timestamp when the report was completed.

Example:

"2022-05-04T12:00:00.000Z"

​
last_task_at
string<date-time>
required
read-only

Created timestamp of the latest task.

Example:

"2022-05-04T12:00:00.000Z"

​
links
object[]
required

List of employment links