VOIE Reports

Create an income and employment report

Changed on

The endpoint creates a report for a user.

post/v1/users/{user_id}/reports/

Request

  • Base URL
    https://prod.truv.com
  • URL
    https://prod.truv.com/v1/users/{user_id}/reports/
  • Auth
    API key in header X-Access-Client-Id and API key in header X-Access-Secret

Request body

is_voeboolean

A boolean parameter to request a Verification of Employment report.

Example request

{
  "is_voe": true
}

Response

report_idstring required

Unique identifier of the report.

created_atstring date-time required

Timestamp when the report was created.

completed_atstring date-time required

Timestamp when the report was completed.

last_task_atstring date-time required

Created timestamp of the latest task.

Example response

{
  "report_id": "48427a36d43c4d5aa6324bc06c692456",
  "created_at": "2022-05-04T11:30:00Z",
  "completed_at": "2022-05-04T12:00:00Z",
  "last_task_at": "2022-05-04T12:00:00Z",
  "links": [
    {
      "id": "24d7e80942ce4ad58a93f70ce4115f5c",
      "link_id": "150491a20bdb4292bb2a2ad8554fecba",
      "data_source": "payroll",
      "employments": [
        {
          "income": "70000.00",
          "income_unit": "YEARLY",
          "pay_rate": "5833.33",
          "pay_frequency": "M",
          "statements": [
            {
              "id": "24d7e80942ce4ad58a93f70ce4115f5c",
              "check_number": "29205182",
              "pay_date": "2018-05-31",
              "net_pay": "12915.44",
              "net_pay_ytd": "39642.52",
              "gross_pay": "18038.33",
              "gross_pay_ytd": "55366.65",
              "bonus": "100.00",
              "commission": "12000.00",
              "hours": "173.33",
              "basis_of_pay": "S",
              "period_start": "2018-05-01",
              "period_end": "2018-05-31",
              "regular": "5833.33",
              "regular_ytd": "29166.65",
              "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": "5833.33",
                  "category": "regular",
                  "rate": null,
                  "units": null
                },
                {
                  "name": "Overtime",
                  "amount": "45.00",
                  "category": "overtime",
                  "rate": "22.50",
                  "units": "2"
                },
                {
                  "name": "Commission",
                  "amount": "12000.00",
                  "category": "commission",
                  "rate": null,
                  "units": null
                },
                {
                  "name": "Bonus",
                  "amount": "100.00",
                  "category": "bonus",
                  "rate": null,
                  "units": null
                },
                {
                  "name": "Spot Award",
                  "amount": "60.00",
                  "category": "other_pay",
                  "rate": null,
                  "units": null
                }
              ],
              "earnings_ytd": [
                {
                  "name": "Regular",
                  "amount": "29166.65",
                  "category": "regular",
                  "rate": null,
                  "units": null
                },
                {
                  "name": "Overtime",
                  "amount": "500.00",
                  "category": "overtime",
                  "rate": null,
                  "units": null
                },
                {
                  "name": "Commission",
                  "amount": "24000.00",
                  "category": "commission",
                  "rate": null,
                  "units": null
                },
                {
                  "name": "Bonus",
                  "amount": "1000.00",
                  "category": "bonus",
                  "rate": null,
                  "units": null
                },
                {
                  "name": "Spot Award",
                  "amount": "700.00",
                  "category": "other_pay",
                  "rate": null,
                  "units": null
                }
              ],
              "deductions": [
                {
                  "name": "Federal Income Tax",
                  "amount": "2705.75",
                  "category": "federal"
                },
                {
                  "name": "Social Security Tax",
                  "amount": "1118.38",
                  "category": "socialsec"
                },
                {
                  "name": "Medicare Tax",
                  "amount": "261.56",
                  "category": "medicare"
                },
                {
                  "name": "VA State Income Tax",
                  "amount": "1037.20",
                  "category": "state"
                }
              ],
              "deductions_ytd": [
                {
                  "name": "Federal Income Tax",
                  "amount": "8305.00",
                  "category": "federal"
                },
                {
                  "name": "Social Security Tax",
                  "amount": "3432.73",
                  "category": "socialsec"
                },
                {
                  "name": "Medicare Tax",
                  "amount": "802.82",
                  "category": "medicare"
                },
                {
                  "name": "VA State Income Tax",
                  "amount": "3183.58",
                  "category": "state"
                }
              ],
              "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": "29166.65",
              "bonus": "1000.00",
              "commission": "24000.00",
              "overtime": "500.00",
              "other_pay": "700.00",
              "net_pay": "39642.52",
              "gross_pay": "55366.65"
            }
          ],
          "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": "70000.00",
              "federal_tax": "5830.87",
              "social_security_wages": "70000.00",
              "social_security_tax": "4340.00",
              "medicare_wages": "70000.00",
              "medicare_tax": "1015.00",
              "gross_pay": "70000.00"
            }
          ],
          "id": "24d7e80942ce4ad58a93f70ce4115f5c",
          "job_title": "PR associate",
          "job_type": "F",
          "start_date": "2018-01-01",
          "original_hire_date": "2017-06-21",
          "derived_fields": [
            "is_active"
          ],
          "missing_data_fields": [
            "w2s"
          ],
          "manager_name": "Jenny McDouglas",
          "profile": {
            "id": "48427a36d43c4d5aa6324bc06c692456",
            "created_at": "2022-06-07T15:00:00Z",
            "updated_at": "2022-06-30T15:00:00Z",
            "first_name": "John",
            "last_name": "Doe",
            "full_name": "John Doe",
            "middle_initials": "K",
            "email": "john.doe@example.com",
            "ssn": "123456789",
            "date_of_birth": "1992-03-03",
            "home_address": {
              "street": "1 Morgan Ave",
              "city": "Los Angeles",
              "state": "CA",
              "zip": "90210",
              "country": "US"
            }
          },
          "company": {
            "name": "Facebook Demo",
            "address": {
              "street": "1 Morgan Ave",
              "city": "Los Angeles",
              "state": "CA",
              "zip": "90210",
              "country": "US"
            },
            "phone": "6503087300",
            "ein": "770493581"
          },
          "last_period_end": "2022-05-04",
          "last_pay_date": "2022-05-04"
        }
      ]
    }
  ]
}

Changes

    • warning

      added the new C enum value to the ////// response property for the response status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the //// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the //// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ///// response's property pattern ^(\d{4}|\d{9})$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the //////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the //////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the //////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the //////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • info

      the ////// response's property pattern ^-?\d{1,10}\.\d{2}$ was added for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • warning

      added the new undefined enum value to the //// response property for the response status

    • warning

      added the new undefined enum value to the //// response property for the response status

    • warning

      added the new undefined enum value to the //// response property for the response status