v4

OpenAPI 3.0.12026-07-3189233676.2 KB

Reports

Retrieve an employment history report for a link

The endpoint returns the VOE report for a link

get/v1/links/{link_id}/employment/report/

Response

idstring required

Unique ID

statusstring required

Request status

finished_atstring required

Time when report was finished

completed_atstring required

Time when report was completed (Deprecated, invalid datetime format)

access_tokenstring required

Access token for a Link to payroll provider

tracking_infostring nullable required

Any information passed to the Truv Bridge from a partner

is_suspiciousboolean

Flag to indicate if the data from the source is suspicious. E.g. fraud detected in uploaded documents or SSN of the user does not match with the data

pdf_reportstring uri

Verification report in PDF format

providerstring required

Payroll provider name

data_source'payroll' | 'docs' | 'financial_accounts'

Source of data: crawler - payroll provider parsing, docs - user uploaded documents

Example response

{
  "id": "24d7e80942ce4ad58a93f70ce4115f5c",
  "status": "new",
  "finished_at": "2021-04-06T11:30:00Z",
  "completed_at": "2021-04-06 11:30:00+00:00",
  "access_token": "48427a36d43c4d5aa6324bc06c692456",
  "tracking_info": "user123456",
  "employments": [
    {
      "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"
      }
    }
  ],
  "pdf_report": "https://cdn.truv.com/report.pdf",
  "provider": "adp",
  "data_source": "payroll"
}